Class Step

constructor

• new Step(
      name: string,
      action: StepActions,
      contextID?: number,
      options?: StepOptions,
  ): Step

• Parameters

  • name: string
  • action: StepActions
  • OptionalcontextID: number
  • options: StepOptions = {}

  Returns Step

action

ReadonlycontextType

options

Static ReadonlychildTypes

Static ReadonlyresourceType

deleteDataLayerValidation

• deleteDataLayerValidation(index: number): void

• Parameters

  • index: number

  Returns void

deleteTagValidation

• deleteTagValidation(index: number): void

• Parameters

  • index: number

  Returns void

getDataLayerValidations

• getDataLayerValidations(): readonly DataLayerValidation[]

• Returns readonly DataLayerValidation[]

getTagValidations

• getTagValidations(): readonly TagValidation[]

• Returns readonly TagValidation[]

insertDataLayerValidation

• insertDataLayerValidation(
      dataLayerValidation: DataLayerValidation,
      index?: number,
  ): void

• Parameters

  • dataLayerValidation: DataLayerValidation
  • index: number = ...

  Returns void

insertTagValidation

• insertTagValidation(tagValidation: TagValidation, index?: number): void

• Parameters

  • tagValidation: TagValidation
  • index: number = ...

  Returns void

setOptions

• setOptions(options: StepOptions, override?: boolean): void

• Set options from the passed options object

  Parameters

  • options: StepOptions

    the object to set options from
  • override: boolean = false

    whether to override the options object

  Returns void

toJSON

• toJSON(): Promise<Record<string, any>>

• Convert the resource to an Object

  Returns Promise<Record<string, any>>

  object representation of the resource

StaticfromID

• fromID(id: number): Promise<Step>

• Create a resource from a given ID

  Parameters

  • id: number

    the ID of the resource

  Returns Promise<Step>

  Promise of the resource

StaticfromJSON

• fromJSON(obj: Record<string, any>, copy?: boolean): Step

• Create a resource from an object

  Parameters

  • obj: Record<string, any>

    object to create resource from
  • copy: boolean = false

    whether to create a copy of the resource or not (removes resource IDs)

  Returns Step

  new Resource