Interface IFunction

Provides interfaces for defining and working with functions at runtime, including metadata for function declarations and execution scripts.

interface IFunction {
    get isIFunction(): true;
    execute<T = any>(...args: any[]): T;
    getContext(): string;
    getDeclaration(): IFunction.IDeclaration;
    getDescriptor(locale?: string): Promise<IFunction.IDescriptor>;
    getName(): string;
    isBuiltIn(): boolean;
}

Index

Accessors

Methods

execute getContext getDeclaration getDescriptor getName isBuiltIn

Accessors

isIFunction

get isIFunction(): true
For runtime reflection.

Returns true

Methods

execute

execute<T = any>(...args: any[]): T
Execute the function
Type Parameters
- T = any
Parameters
- ...args: any[]
Returns T

getContext

getContext(): string
Returns the context in which the function is executed.

Returns string
Remarks
Not all functions have a context.

getDeclaration

getDeclaration(): IFunction.IDeclaration
Contains type information needed to safely execute the function.

Returns IFunction.IDeclaration

getDescriptor

getDescriptor(locale?: string): Promise<IFunction.IDescriptor>
Returns user-facing information about the function.
Parameters
- Optionallocale: string
Returns Promise<IFunction.IDescriptor>

getName

getName(): string
The name of the function.

Returns string

isBuiltIn

isBuiltIn(): boolean
Indicates whether the function is a built-in function.

Returns boolean