Class Suite

constructor

• new Suite(name: string, contextID?: number, options?: SuiteOptions): Suite

  Parameters

  • name: string
  • OptionalcontextID: number
  • options: SuiteOptions = {}

  Returns Suite

ReadonlycontextType

OptionaljobID

options

Static ReadonlychildTypes

Static ReadonlyresourceType

Static ReadonlyresourceTypeRun

deleteTest

• deleteTest(index: number): Promise<void>

  Parameters

  • index: number

  Returns Promise<void>

getTests

• getTests(): Promise<readonly Test[]>

  Returns Promise<readonly Test[]>

insertTest

• insertTest(test: Test, index?: number): Promise<void>

  Parameters

  • test: Test
  • index: number = ...

  Returns Promise<void>

progress

• progress(): Promise<JobStatus>

  Retrieve the JobStatus for a resource

  Returns Promise<JobStatus>

  Promise of the JobStatus

run

• run(emailUsers?: number[], variables?: Record<string, string>): Promise<string>

  Run the resource in DataTrue

  Parameters

  • emailUsers: number[] = []
  • variables: Record<string, string> = {}

    variables to set for the test run

  Returns Promise<string>

  Promise of the jobID

setOptions

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

  Set options from the passed options object

  Parameters

  • options: SuiteOptions

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

    whether to override the options object

  Returns void

setVariable

• setVariable(name: string, type: VariableTypes, value: string): void

  Parameters

  • name: string
  • type: VariableTypes
  • value: string

  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<Suite>

  Create a resource from a given ID

  Parameters

  • id: number

    the ID of the resource

  Returns Promise<Suite>

  Promise of the resource

StaticfromJSON

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

  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 Suite

  new Resource