Class Step

Base class for all DataTrue resource types

Hierarchy (View Summary)

Resource
- Step

Constructors

constructor

new Step(
    name: string,
    action: StepActions,
    contextID?: number,
    options?: StepOptions,
): Step
Parameters
- name: string
- action: StepActions
- OptionalcontextID: number
- options: StepOptions = {}
Returns Step
Overrides Resource.constructor
- Defined in resources/step.ts:95

Properties

action

action: StepActions

`Readonly`contextType

contextType: string = "test"

name

name: string

options

options: StepOptions = {}

`Static` `Readonly`childTypes

childTypes: readonly string[] = ...

`Static` `Readonly`resourceType

resourceType: string = "step"

`Static` `Optional` `Readonly`resourceTypeRun

resourceTypeRun?: string

Methods

delete

delete(): Promise<void>
Delete the resource in DataTrue

Returns Promise<void>
Promise
Inherited from Resource.delete
- Defined in resources/resource.ts:375

deleteDataLayerValidation

deleteDataLayerValidation(index: number): void
Parameters
- index: number
Returns void
- Defined in resources/step.ts:172

deleteTagValidation

deleteTagValidation(index: number): void
Parameters
- index: number
Returns void
- Defined in resources/step.ts:168

getContextID

getContextID(): undefined | number
Gets the contextID of a resource

Returns undefined | number
contextID of the resource
Inherited from Resource.getContextID
- Defined in resources/resource.ts:84

getContextType

getContextType(): string
Gets the contextType of a resource

Returns string
contextType of the resource
Inherited from Resource.getContextType
- Defined in resources/resource.ts:93

getDataLayerValidations

getDataLayerValidations(): readonly DataLayerValidation[]
Returns readonly DataLayerValidation[]
- Defined in resources/step.ts:180

getResourceID

getResourceID(): undefined | number
Gets the resourceID of a resource

Returns undefined | number
resourceID of the resource
Inherited from Resource.getResourceID
- Defined in resources/resource.ts:75

getTagValidations

getTagValidations(): readonly TagValidation[]
Returns readonly TagValidation[]
- Defined in resources/step.ts:176

insertDataLayerValidation

insertDataLayerValidation(
dataLayerValidation: DataLayerValidation,
index?: number,
): void
Parameters
- dataLayerValidation: DataLayerValidation
- index: number = ...
Returns void
- Defined in resources/step.ts:161

insertTagValidation

insertTagValidation(tagValidation: TagValidation, index?: number): void
Parameters
- tagValidation: TagValidation
- index: number = ...
Returns void
- Defined in resources/step.ts:154

save

save(): Promise<void>
Save a resource to DataTrue

Returns Promise<void>
Promise
Inherited from Resource.save
- Defined in resources/resource.ts:178

setContextID

setContextID(id: undefined | number): void
Sets the contextID of a resource
Parameters
- id: undefined | number
  the contextID to set
Returns void
Inherited from Resource.setContextID
- Defined in resources/resource.ts:122

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
Overrides Resource.setOptions
- Defined in resources/step.ts:184

setResourceID

setResourceID(id: undefined | number): void
Sets the resourceID of a resource
Parameters
- id: undefined | number
  the resourceID to set
Returns void
Inherited from Resource.setResourceID
- Defined in resources/resource.ts:102

toJSON

toJSON(): Promise<Record<string, any>>
Convert the resource to an Object

Returns Promise<Record<string, any>>
object representation of the resource
Overrides Resource.toJSON
- Defined in resources/step.ts:188

toString

toString(): Promise<string>
Convert the resource to a JSON string

Returns Promise<string>
the resource represented as a JSON string
Inherited from Resource.toString
- Defined in resources/resource.ts:66

`Static`fromID

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
Overrides Resource.fromID
- Defined in resources/step.ts:105

`Static`fromJSON

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
Overrides Resource.fromJSON
- Defined in resources/step.ts:110