FormulaFunctionMetadata | @sheetwrite/core/functions

One metadata format for built-in and host functions.

Source: packages/core/src/functions/types.ts#L16

Members 6

name

readonly name: string;

description

readonly description: string;

arguments

readonly arguments: readonly FormulaArgumentMetadata[];

returnKind

readonly returnKind: string;

examples

readonly examples?: readonly string[];

volatile

readonly volatile?: boolean;

Declaration

View full TypeScript declaration

export interface FormulaFunctionMetadata {
  readonly name: string;
  readonly description: string;
  readonly arguments: readonly FormulaArgumentMetadata[];
  readonly returnKind: string;
  readonly examples?: readonly string[];
  readonly volatile?: boolean;
}

Referenced by

Workspace packages depending on @sheetwrite/core

@sheetwrite/benchdependency
@sheetwrite/chartsdependency
@sheetwrite/docs-startdependency
@sheetwrite/reactdependency
@sheetwrite/sveltedependency
@sheetwrite/vuedependency
@sheetwrite/xlsxdependency

Public exports naming FormulaFunctionMetadata

listFunctions@sheetwrite/core
registerFunction@sheetwrite/core

Loading documentation…