Skip to content

RegisterFormulaFunctionParams

Parameters for registerFormulaFunction.

Import:

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

Signature:

export interface RegisterFormulaFunctionParams extends CreateFormulaFunctionParams

Extends: CreateFormulaFunctionParams

Properties

PropertyTypeDescription
docString?(() => string) | stringDescription shown in formula completion.
(Inherited from CreateFormulaFunctionParams)
evaluate(context: FormulaContext | null, ...arguments_: (null | Value)[]) => ValueSynchronous 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)
namestringFunction name, matched case-insensitively by Obsidian.
(Inherited from CreateFormulaFunctionParams)
paramsFormulaFunctionParam[]Parameters, including the receiver first for an instance function.
(Inherited from CreateFormulaFunctionParams)
pluginPluginPlugin whose unload removes the registration.

Links to this page: