EngineResource | @acaengine/ts-client

Type parameters

T: ResourceService<any>

Hierarchy

EngineResource

Index

Constructors

constructor

Properties

Accessors

changes

Methods

Constructors

constructor

new EngineResource(_service: T, raw_data: HashMap): EngineResource

- Defined in http/services/resources/resource.class.ts:34
Parameters
- _service: T
- raw_data: HashMap
Returns EngineResource

Properties

Protected _changes

_changes: HashMap

Map of unsaved property changes

Protected Optional _init_sub

_init_sub: Subscription

Subscription for initialisation events

Protected _server_names

_server_names: HashMap

Map of local property names to server ones

Protected _service

_service: T

Protected _version

_version: number

Version of the data

changeEvents

changeEvents: Subject<EngineDataClassEvent> = new Subject<EngineDataClassEvent>()

Subject for change events to the class object

created_at

created_at: number

Unix epoch in seconds of the creation time of the object

id

id: string

Unique Identifier of the object

name

name: string

Human readable name of the object

Accessors

changes

get changes(): HashMap

- Defined in http/services/resources/resource.class.ts:24
Get map of changes to the resources

Returns HashMap

Methods

Protected change

change<U>(prop_name: string, value: U): void

- Defined in http/services/resources/resource.class.ts:145
Update the value of a property

Type parameters
- U
Parameters
- prop_name: string
  
  Name of the property
- value: U
  
  New value for the property
Returns void

clearPendingChanges

clearPendingChanges(): void

- Defined in http/services/resources/resource.class.ts:65
Clear any pending changes to object

Returns void

delete

delete(): Promise<void>

- Defined in http/services/resources/resource.class.ts:111
Make request to delete the resource on the server

Returns Promise<void>

emit

emit(type: EngineDataEventType, metadata?: HashMap): void

- Defined in http/services/resources/resource.class.ts:76
Emits change event

Parameters
- type: EngineDataEventType
  
  Type of change that has occurred
- Default value metadata: HashMap = {}
  
  Supporting metadata for the event
Returns void

save

save(type?: "put" | "patch"): Promise<T>

- Defined in http/services/resources/resource.class.ts:83
Save any changes made to the server

Parameters
- Default value type: "put" | "patch" = "patch"
Returns Promise<T>

storePendingChange

storePendingChange(key: string, value: any): this

- Defined in http/services/resources/resource.class.ts:48
Store new value for given property

Parameters
- key: string
  
  Name of the property to store the new value
- value: any
  
  New value for the property
Returns this

toJSON

toJSON(this: EngineResource<T>, with_changes?: boolean): HashMap

- Defined in http/services/resources/resource.class.ts:118
Convert object into plain object

Parameters
- this: EngineResource<T>
- Default value with_changes: boolean = true
Returns HashMap

Generated using TypeDoc

Type parameters

T: ResourceService<any>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_service: T

raw_data: HashMap

Returns EngineResource

Properties

Protected _changes

Protected Optional _init_sub

Protected _server_names

Protected _service

Protected _version

changeEvents

created_at

id

name

Accessors

changes

Returns HashMap

Methods

Protected change

Type parameters

U

Parameters

prop_name: string

value: U

Returns void

clearPendingChanges

Returns void

delete

Returns Promise<void>

emit

Parameters

type: EngineDataEventType

Default value metadata: HashMap = {}

Returns void

save

Parameters

Default value type: "put" | "patch" = "patch"

Returns Promise<T>

storePendingChange

Parameters

key: string

value: any

Returns this

toJSON

Parameters

this: EngineResource<T>

Default value with_changes: boolean = true

Returns HashMap