Class Step

Base class for all DataTrue resource types

Hierarchy

Constructors

Properties

action: StepActions
contextType: string = "test"
name: string
options: StepOptions = {}
childTypes: readonly string[] = ...
resourceType: string = "step"
resourceTypeRun?: string

Methods

  • Parameters

    • index: number

    Returns void

  • Parameters

    • index: number

    Returns 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

  • Convert the resource to an Object

    Returns

    object representation of the resource

    Returns Promise<Record<string, any>>

  • Convert the resource to a JSON string

    Returns

    the resource represented as a JSON string

    Returns Promise<string>

  • Create a resource from a given ID

    Returns

    Promise of the resource

    Parameters

    • id: number

      the ID of the resource

    Returns Promise<Step>

  • Create a resource from an object

    Returns

    new Resource

    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

Generated using TypeDoc