Class Account

Base class for all DataTrue resource types

Hierarchy (View Summary)

Resource
- Account

Constructors

constructor

new Account(name: string): Account
Parameters
- name: string
Returns Account
Overrides Resource.constructor
- Defined in resources/account.ts:16

Properties

`Optional`allowanceResetAt

allowanceResetAt?: Date

`Readonly`contextType

contextType: string = ""

name

name: string

options

options: ResourceOptions = {}

`Optional`stepsTotal

stepsTotal?: number

`Optional`stepsUsed

stepsUsed?: number

`Static` `Readonly`childTypes

childTypes: readonly string[] = ...

`Static` `Readonly`resourceType

resourceType: string = "account"

`Static` `Optional` `Readonly`resourceTypeRun

resourceTypeRun?: string

Methods

delete

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

Returns Promise<void>
Promise
Overrides Resource.delete
- Defined in resources/account.ts:147

getContextID

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

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

getContextType

getContextType(): string
Gets the contextType of a resource

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

getResourceID

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

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

getSuites

getSuites(): Promise<readonly Suite[]>
Returns Promise<readonly Suite[]>
- Defined in resources/account.ts:163

insertSuite

insertSuite(suite: Suite, index?: number): Promise<void>
Parameters
- suite: Suite
- index: number = ...
Returns Promise<void>
- Defined in resources/account.ts:154

save

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

Returns Promise<void>
Promise
Overrides Resource.save
- Defined in resources/account.ts:140

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

setOptions

setOptions(options: ResourceOptions, override?: boolean): void
Set options from the passed options object
Parameters
- options: ResourceOptions
  the object to set options from
- Optionaloverride: boolean
  whether to override the options object
Returns void
Inherited from Resource.setOptions
- 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
Inherited from Resource.setResourceID
- Defined in resources/resource.ts:102

toJSON

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

Returns Promise<Record<string, any>>
object representation of the resource
Overrides Resource.toJSON
- Defined in resources/account.ts:167

toString

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

Returns Promise<string>
the resource represented as a JSON string
Inherited from Resource.toString
- Defined in resources/resource.ts:66

`Static`fromID

fromID(id: number): Promise<Account>
Create a resource from a given ID
Parameters
- id: number
  the ID of the resource
Returns Promise<Account>
Promise of the resource
Overrides Resource.fromID
- Defined in resources/account.ts:20

`Static`fromJSON

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

`Static`getAccounts

getAccounts(): Promise<Account[]>
Returns Promise<Account[]>
- Defined in resources/account.ts:62