RegisterFormulaFunctionParams
Parameters for registerFormulaFunction.
Import:
import type { RegisterFormulaFunctionParams } from '@mnaoumov/obsidian-lib/formula-function';Signature:
export interface RegisterFormulaFunctionParams extends CreateFormulaFunctionParamsExtends: CreateFormulaFunctionParams
Properties
| Property | Type | Description |
|---|---|---|
| docString? | (() => string) | string | Description shown in formula completion. (Inherited from CreateFormulaFunctionParams) |
| evaluate | (context: FormulaContext | null, ...arguments_: (null | Value)[]) => Value | Synchronous evaluator. Direct apply calls receive a null context.(Inherited from CreateFormulaFunctionParams) |
| instanceType? | Constructor<Value> | The receiver class for an instance function; omit for a global function. (Inherited from CreateFormulaFunctionParams) |
| name | string | Function name, matched case-insensitively by Obsidian. (Inherited from CreateFormulaFunctionParams) |
| params | FormulaFunctionParam[] | Parameters, including the receiver first for an instance function. (Inherited from CreateFormulaFunctionParams) |
| plugin | Plugin | Plugin whose unload removes the registration. |
Links to this page: