@datatrue/api
    Preparing search index...

    Class Step

    Base class for all DataTrue resource types

    Hierarchy (View Summary)

    Index
    constructor
    action contextType name options childTypes resourceType resourceTypeRun?
    delete deleteDataLayerValidation deleteTagValidation getContextID getContextType getDataLayerValidations getResourceID getTagValidations insertDataLayerValidation insertTagValidation save setContextID setOptions setResourceID toJSON toString fromID fromJSON
    action: StepActions
    contextType: string = "test"
    name: string
    options: StepOptions = {}
    childTypes: readonly string[] = ...
    resourceType: string = "step"
    resourceTypeRun?: string

    • 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 Promise<Record<string, any>>

      object representation of the resource

    • Convert the resource to a JSON string

      Returns Promise<string>

      the resource represented as a JSON string

    • Create a resource from a given ID

      Parameters

      • id: number

        the ID of the resource

      Returns Promise<Step>

      Promise of the resource

    • 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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods