Class Test

Base class for all DataTrue resource types

Hierarchy

Implements

Constructors

Properties

contextType: string = "suite"
jobID?: string
name: string
options: TestOptions = ...
testType: TestTypes = TestTypes.SIMULATION
childTypes: readonly string[] = ...
resourceType: string = "test"
resourceTypeRun: string = "TestScenario"

Methods

  • Parameters

    • index: number

    Returns void

  • Run the resource in DataTrue

    Returns

    Promise of the jobID

    Parameters

    • emailUsers: number[] = []

      an array of user IDs to whom the test results should be sent

    • variables: Record<string, string> = {}

      variables to set for the test run

    Returns Promise<string>

  • Set options from the passed options object

    Parameters

    • options: TestOptions

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

  • 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 Test

Generated using TypeDoc