Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IBaseFunction

Hierarchy

  • IBaseFunction

Implemented by

Index

Methods

Methods

clone

  • Returns IBaseFunction

execute

  • execute(preexecutedArguments: any[], environment: any, node: any, execPath?: undefined | string): any

  • execute function and return the result or an error.

    Parameters

    • preexecutedArguments: any[]
    • environment: any

      The script environment. cast to ScriptEnvironment

    • node: any

      Node of this function. cast to Node

    • Optional execPath: undefined | string

    Returns any

executeAsync

  • executeAsync(preexecutedArguments: any[], environment: any, node: any, execPath?: undefined | string): Promise<any>

  • asyncron execute of the function. Returns a promise with the result or an error.

    Parameters

    • preexecutedArguments: any[]
    • environment: any

      The script environment. cast to ScriptEnvironment

    • node: any

      Node of this function. cast to Node

    • Optional execPath: undefined | string

    Returns Promise<any>

getDescription

  • getDescription(): string

  • Returns the description of this function. An empty string if a description is not available.

    Returns string

getName

  • getName(): string

  • Returns the name of the function

    Returns string

getOperator

  • getOperator(): string

  • Returns the operator-character of this function.

    throws

    Throws an error if this function is not useable as operation.

    Returns string

getPriority

  • getPriority(): number

  • Returns the priority of this function. Only needed for operators.

    Returns number

hasHigherPriorityThan

  • hasHigherPriorityThan(priority: number): boolean

  • Returns true if the priority of this function is higher than the provided priority

    Parameters

    • priority: number

    Returns boolean

isAsyncron

  • isAsyncron(): boolean

  • Returns true if this function must be called asyncron and returns the value not immediately.

    Returns boolean

isOperator

  • isOperator(): boolean

  • Returns true if this function is also available as operation (using operator)

    Returns boolean

isPreexecutedArgument

  • isPreexecutedArgument(index: number, node: any): boolean

  • Returns true, if the argument (node-children) should be executed before execute of this function is called. By default, returns true for all arguments. Override in function if certain arguments are executed for getting ther value inside the execute-method.

    Parameters

    • index: number

      Zero-based index of the argument

    • node: any

      The node, none executed (result is not availabe at that time). cast to Node

    Returns boolean

isStoring

  • isStoring(): boolean

  • Returns true if this function is storing values between the calls. So, an instance needs to be created for each occurrence.

    Returns boolean

toString

  • toString(): string

  • Returns string

Generated using TypeDoc