Skip to content

CreateFormulaFunctionParams

Parameters for createFormulaFunction.

Import:

import type { CreateFormulaFunctionParams } from '@mnaoumov/obsidian-lib/formula-function';

Signature:

export interface CreateFormulaFunctionParams

Properties

PropertyTypeDescription
docString?(() => string) | stringDescription shown in formula completion.
evaluate(context: FormulaContext | null, ...arguments_: (null | Value)[]) => ValueSynchronous evaluator. Direct apply calls receive a null context.
instanceType?Constructor<Value>The receiver class for an instance function; omit for a global function.
namestringFunction name, matched case-insensitively by Obsidian.
paramsFormulaFunctionParam[]Parameters, including the receiver first for an instance function.

Links to this page: