Class Resource`Abstract`

Base class for all DataTrue resource types

Hierarchy

Resource
- Account
- DataLayerValidation
- Step
- Suite
- TagValidation
- Test

Index

Constructors

Properties

name options childTypes resourceType resourceTypeRun?

Methods

delete getContextID getContextType getResourceID save setContextID setOptions setResourceID toJSON toString fromID fromJSON

Constructors

constructor

new Resource(name: string): Resource
Parameters
- name: string
Returns Resource
- Defined in resources/resource.ts:31

Properties

name

name: string

options

options: ResourceOptions = {}

`Static` `Readonly` childTypes

childTypes: readonly string[]

`Static` `Readonly` resourceType

resourceType: string

`Static` `Optional` `Readonly` resourceTypeRun

resourceTypeRun?: string

Methods

delete

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

Returns
Promise

Returns Promise<void>
- Defined in resources/resource.ts:375

getContextID

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

Returns
contextID of the resource

Returns undefined | number
- Defined in resources/resource.ts:84

getContextType

getContextType(): string
Gets the contextType of a resource

Returns
contextType of the resource

Returns string
- Defined in resources/resource.ts:93

getResourceID

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

Returns
resourceID of the resource

Returns undefined | number
- Defined in resources/resource.ts:75

save

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

Returns
Promise

Returns Promise<void>
- 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
- Defined in resources/resource.ts:122

setOptions

setOptions(options: ResourceOptions, override?: boolean): void
Set options from the passed options object
Parameters
- options: ResourceOptions
  
  the object to set options from
- Optional override: boolean
  
  whether to override the options object
Returns void
- Defined in resources/resource.ts:132

setResourceID

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

`Abstract` toJSON

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

Returns
object representation of the resource

Returns Promise<Record<string, any>>
- Defined in resources/resource.ts:59

toString

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

Returns
the resource represented as a JSON string

Returns Promise<string>
- Defined in resources/resource.ts:66

`Static` fromID

fromID(id: number): Promise<Resource>
Create a resource from a given ID

Returns
Promise of the resource
Parameters
- id: number
  
  the ID of the resource
Returns Promise<Resource>
- Defined in resources/resource.ts:39

`Static` fromJSON

fromJSON(obj: Record<string, any>, copy?: boolean): Resource
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 Resource
- Defined in resources/resource.ts:50

Generated using TypeDoc