Class PluginAbstract

constructor

• new Plugin(options, childFormula): Plugin

• Parameters

  • options: Record<any, any>
  • childFormula: undefined | Formula

  Returns Plugin

formula

options

AbstractenrichData

• enrichData(data, logger?): Promise<Record<string, any>>

• Enriches the data for the child formula

  Parameters

  • data: Record<string, any>

    The original data for evaluation
  • Optionallogger: Logger

    Optionally pass a logger

  Returns Promise<Record<string, any>>

  The enriched data that is then used to evaluate the child formula

evaluate

• evaluate(data): Promise<FormulaResults | FormulaResults[]>

• Evaluates the formula with the given data

  Parameters

  • data: Record<string, any>

    The data that's used for evaluation

  Returns Promise<FormulaResults | FormulaResults[]>

AbstractgetName

• getName(): string

• Get the name of the plugin

  Returns string

AbstractgetVersion

• getVersion(): string

• Get the version of the plugin

  Returns string

toJsonReady

• toJsonReady(): Record<string, any>
• Internal

  Prepares object for conversion into rita json

  Returns Record<string, any>

validate

• validate(): boolean

• Check if the formula is valid

  Returns boolean