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