Class TagValidation

Base class for all DataTrue resource types

Hierarchy

Resource
- TagValidation

Index

Constructors

constructor

new TagValidation(name: string, key: string, contextType?: TagValidationContexts, contextID?: number, options?: TagValidationOptions): TagValidation
Parameters
- name: string
- key: string
- contextType: TagValidationContexts = TagValidationContexts.STEP
- Optional contextID: number
- options: TagValidationOptions = {}
Returns TagValidation
Overrides Resource.constructor
- Defined in resources/tagValidation.ts:62

Properties

name

name: string

options

options: TagValidationOptions = {}

tagDefinition

tagDefinition: TagDefinition

`Static` `Readonly` childTypes

childTypes: readonly string[] = []

`Static` `Readonly` resourceType

resourceType: string = "tag_validation"

`Static` `Optional` `Readonly` resourceTypeRun

resourceTypeRun?: string

Methods

delete

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

Returns
Promise

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

deleteQueryValidation

deleteQueryValidation(index: number): void
Parameters
- index: number
Returns void
- Defined in resources/tagValidation.ts:134

getContextID

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

Returns
contextID of the resource

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

getContextType

getContextType(): string
Gets the contextType of a resource

Returns
contextType of the resource

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

getQueryValidations

getQueryValidations(): readonly QueryValidation[]
Returns readonly QueryValidation[]
- Defined in resources/tagValidation.ts:138

getResourceID

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

Returns
resourceID of the resource

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

insertQueryValidation

insertQueryValidation(queryValidation: QueryValidation, index?: number): void
Parameters
- queryValidation: QueryValidation
- index: number = ...
Returns void
- Defined in resources/tagValidation.ts:127

report

report(): Promise<TagValidationReport>
Returns Promise<TagValidationReport>
- Defined in resources/tagValidation.ts:180

save

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

Returns
Promise

Returns Promise<void>
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

setContextType

setContextType(contextType: TagValidationContexts): void
Parameters
- contextType: TagValidationContexts
Returns void
- Defined in resources/tagValidation.ts:161

setOptions

setOptions(options: TagValidationOptions, override?: boolean): void
Set options from the passed options object
Parameters
- options: TagValidationOptions
  
  the object to set options from
- override: boolean = false
  
  whether to override the options object
Returns void
Overrides Resource.setOptions
- Defined in resources/tagValidation.ts:142

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
object representation of the resource

Returns Promise<Record<string, any>>
Overrides Resource.toJSON
- Defined in resources/tagValidation.ts:165

toString

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

Returns
the resource represented as a JSON string

Returns Promise<string>
Inherited from Resource.toString
- Defined in resources/resource.ts:66

`Static` fromID

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

Returns
Promise of the resource
Parameters
- id: number
  
  the ID of the resource
Returns Promise<TagValidation>
Overrides Resource.fromID
- Defined in resources/tagValidation.ts:76

`Static` fromJSON

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

Generated using TypeDoc