Class ItemConditional

constructor

• new ItemConditional(data, options): ItemConditional

• Parameters

  • data: any

  • options: any

  Returns ItemConditional

modifiers

id

• get id(): string

• Returns string

Static defaultData

• get defaultData(): any

• Returns any

_configure

• _configure(options): void

• Parameters

  • options: any

  Returns void

_prepareModifiers

• _prepareModifiers(): void
• Internal

  Returns void

delete

• delete(): Promise<any>

• Delete conditional

  Returns Promise<any>

prepareData

• prepareData(): void
• Internal

  Returns void

update

• update(updateData, options?): Promise<any>

• Update conditional

  Parameters

  • updateData: object

  • options: object = {}

  Returns Promise<any>

Static create

• create(data, context?): ItemConditional[]

• Create new conditional

  Parameters

  • data: object | object[]

    Data to create conditional(s) from.

  • context: {
        parent: ItemAction;
    } = {}

    Context data

    • parent: ItemAction

      Parent action to add the conditional to.

  Returns ItemConditional[]

  • Created conditionals

  Throws

  • If no valid parent is defined.

Static defineSchema

• defineSchema(): {
      _id: IDField;
      default: any;
      modifiers: any;
      name: any;
  }

• Returns {
      _id: IDField;
      default: any;
      modifiers: any;
      name: any;
  }

  • _id: IDField

  • default: any

  • modifiers: any

  • name: any

Static pruneData

• pruneData(data): void
• Internal

  Parameters

  • data: object

  Returns void