Class ResourceAbstract

constructor

• new Resource(name): Resource

• Parameters

  • name: string

  Returns Resource

name

options

Static Readonly childTypes

Static Readonly resourceType

Static Optional Readonly resourceTypeRun

delete

• delete(): Promise<void>

• Delete the resource in DataTrue

  Returns Promise<void>

  Promise

getContextID

• getContextID(): undefined | number

• Gets the contextID of a resource

  Returns undefined | number

  contextID of the resource

getContextType

• getContextType(): string

• Gets the contextType of a resource

  Returns string

  contextType of the resource

getResourceID

• getResourceID(): undefined | number

• Gets the resourceID of a resource

  Returns undefined | number

  resourceID of the resource

save

• save(): Promise<void>

• Save a resource to DataTrue

  Returns Promise<void>

  Promise

setContextID

• setContextID(id): void

• Sets the contextID of a resource

  Parameters

  • id: undefined | number

    the contextID to set

  Returns void

setOptions

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

setResourceID

• setResourceID(id): void

• Sets the resourceID of a resource

  Parameters

  • id: undefined | number

    the resourceID to set

  Returns void

Abstract toJSON

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

• Convert the resource to an Object

  Returns Promise<Record<string, any>>

  object representation of the resource

toString

• toString(): Promise<string>

• Convert the resource to a JSON string

  Returns Promise<string>

  the resource represented as a JSON string

Static fromID

• fromID(id): Promise<Resource>

• Create a resource from a given ID

  Parameters

  • id: number

    the ID of the resource

  Returns Promise<Resource>

  Promise of the resource

Static fromJSON

• fromJSON(obj, copy?): Resource

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

  new Resource