Class TagValidation

constructor

• new TagValidation(name, key, contextType?, contextID?, options?): TagValidation

• Parameters

  • name: string
  • key: string
  • contextType: TagValidationContexts = TagValidationContexts.STEP
  • Optional contextID: number
  • options: TagValidationOptions = {}

  Returns TagValidation

options

tagDefinition

Static Readonly childTypes

Static Readonly resourceType

deleteQueryValidation

• deleteQueryValidation(index): void

• Parameters

  • index: number

  Returns void

getQueryValidations

• getQueryValidations(): readonly QueryValidation[]

• Returns readonly QueryValidation[]

insertQueryValidation

• insertQueryValidation(queryValidation, index?): void

• Parameters

  • queryValidation: QueryValidation
  • index: number = ...

  Returns void

report

• report(): Promise<TagValidationReport>

• Returns Promise<TagValidationReport>

setContextType

• setContextType(contextType): void

• Parameters

  • contextType: TagValidationContexts

  Returns void

setOptions

• setOptions(options, override?): 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

toJSON

• toJSON(): Promise<Record<string, any>>

• Convert the resource to an Object

  Returns Promise<Record<string, any>>

  object representation of the resource

Static fromID

• fromID(id): Promise<TagValidation>

• Create a resource from a given ID

  Parameters

  • id: number

    the ID of the resource

  Returns Promise<TagValidation>

  Promise of the resource

Static fromJSON

• fromJSON(obj, copy?): TagValidation

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

  new Resource