Class Atom

constructor

• new Atom(
      path: string,
      isDate?: boolean,
      defaultValue?: FormulaResults | FormulaResults[],
  ): Atom

  Parameters

  • path: string
  • isDate: boolean = false
  • OptionaldefaultValue: FormulaResults | FormulaResults[]

  Returns Atom

OptionaldefaultValue

isDate

path

evaluate

• evaluate(data: Record<string, any>): 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[]>

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

StaticgetPropertyByString

• getPropertyByString(
      object: any,
      path: string,
      defaultVal?: FormulaResults | FormulaResults[],
      context?: Formula,
  ): FormulaResults | FormulaResults[]

  Get the value of an object property or array by a path that is passed as string

  Parameters

  • object: any

    object
  • path: string

    path
  • OptionaldefaultVal: FormulaResults | FormulaResults[]

    default value to return if path is not found
  • Optionalcontext: Formula

    the context of the formula

  Returns FormulaResults | FormulaResults[]