Class Entity<T>

Entity interface.

Type Parameters

T extends EntityData = EntityData

Hierarchy

Entity

Implements

EntityInterface

Constructors

constructor

new Entity<T>(): Entity<T>
Initialize an entity.
Type Parameters
- T extends EntityData = EntityData
Returns Entity<T>
- Defined in packages/client/src/Entity.ts:90

Properties

`Protected` $data

$data: T

The data proxy object.

`Protected` $dataHandler

$dataHandler: Object

The data proxy handler.

`Protected` $dataStore

$dataStore: T

The actual data store.

`Protected` $dirty

$dirty: {
[k: string]: boolean;
} = {}

A map of props to whether they're dirty (for patch).

Type declaration

[k: string]: boolean

`Protected` $isASleepingReference

$isASleepingReference: boolean = false

Whether this instance is a sleeping reference.

$nymph

$nymph: Nymph

The instance of Nymph to use for queries.

`Protected` $originalTags

$originalTags: string[] = []

Array of the entity's original tags (for patch).

`Protected` $sleepingReference

$sleepingReference: null | EntityReference = null

The reference to use to wake.

`Protected` $wakePromise

$wakePromise: null | Promise<Entity<T>> = null

A promise that resolved when the entity's data is wake.

cdate

cdate: null | number = null

The creation date of the entity as a high precision Unix timestamp.

guid

guid: null | string = null

The entity's Globally Unique ID.

mdate

mdate: null | number = null

The modified date of the entity as a high precision Unix timestamp.

`Static` class

class: string = 'Entity'

The lookup name for this entity.

This is used for reference arrays (and sleeping references) and server requests.

`Static` nymph

nymph: Nymph = ...

The instance of Nymph to use for queries.

Methods

$addTag

$addTag(...tags): void
Add one or more tags.
Parameters
- Rest ...tags: string[]
  
  List of tags.
Returns void
Implementation of EntityInterface.$addTag
- Defined in packages/client/src/Entity.ts:369

$arraySearch

$arraySearch(array, strict?): number
Search the array for this object and return the corresponding index.

If strict is false, is() is used to compare. If strict is true, equals() is used.
Parameters
- array: any[]
  
  The array to search.
- strict: boolean = false
  
  Whether to use stronger comparison.
Returns number
The index if the object is in the array, -1 if it isn't.
Implementation of EntityInterface.$arraySearch
- Defined in packages/client/src/Entity.ts:378

$asleep

$asleep(): boolean
Check if this is a sleeping reference.

Returns boolean
- Defined in packages/client/src/Entity.ts:523

`Protected` $check

$check(): void
Check if this is a sleeping reference and throw an error if so.

Returns void
- Defined in packages/client/src/Entity.ts:512

$delete

$delete(): Promise<boolean>
Delete the object from storage.

Returns Promise<boolean>
True on success, false on failure.
Implementation of EntityInterface.$delete
- Defined in packages/client/src/Entity.ts:393

$equals

$equals(object): boolean
Perform a more strict comparison of this object to another.
Parameters
- object: any
  
  The object to compare.
Returns boolean
True or false.
Implementation of EntityInterface.$equals
- Defined in packages/client/src/Entity.ts:401

$getPatch

$getPatch(): EntityPatch
Get a patch of this entity's dirty data to be applied on the server.

Returns EntityPatch
Implementation of EntityInterface.$getPatch
- Defined in packages/client/src/Entity.ts:427

$hasTag

$hasTag(...tags): boolean
Check that the entity has all of the given tags.
Parameters
- Rest ...tags: string[]
  
  List of tags.
Returns boolean
True or false.
Implementation of EntityInterface.$hasTag
- Defined in packages/client/src/Entity.ts:461

$inArray

$inArray(array, strict?): boolean
Check whether this object is in an array.

If strict is false, is() is used to compare. If strict is true, equals() is used.
Parameters
- array: any[]
  
  The array to search.
- strict: boolean = false
  
  Whether to use stronger comparison.
Returns boolean
True if the object is in the array, false if it isn't.
Implementation of EntityInterface.$inArray
- Defined in packages/client/src/Entity.ts:475

$init

$init(entityJson): Entity<T>
Initialize this entity from a JSON representation.
Parameters
- entityJson: null | EntityJson
  
  The entity JSON.
Returns Entity<T>
Implementation of EntityInterface.$init
- Defined in packages/client/src/Entity.ts:339

$is

$is(object): boolean
Perform a less strict comparison of this object to another.
Parameters
- object: any
  
  The object to compare.
Returns boolean
True or false.
Implementation of EntityInterface.$is
- Defined in packages/client/src/Entity.ts:479

$patch

$patch(): Promise<boolean>
Save the object's dirty data to storage.

Returns Promise<boolean>
True on success, false on failure.
Implementation of EntityInterface.$patch
- Defined in packages/client/src/Entity.ts:500

`Protected` $referenceSleep

$referenceSleep(reference): void
Parameters
- reference: EntityReference
Returns void
- Defined in packages/client/src/Entity.ts:608

$refresh

$refresh(): Promise<boolean | 0>
Refresh the object from storage. (Bypasses Nymph's cache.)

If the object has been deleted from storage, the database cannot be reached, or a database error occurs, refresh() will return 0.

Returns Promise<boolean | 0>
False if the data has not been saved, 0 if it can't be refreshed, true on success.
Implementation of EntityInterface.$refresh
- Defined in packages/client/src/Entity.ts:614

$removeTag

$removeTag(...tags): void
Remove one or more tags.
Parameters
- Rest ...tags: string[]
  
  List of tags.
Returns void
Implementation of EntityInterface.$removeTag
- Defined in packages/client/src/Entity.ts:636

$save

$save(): Promise<boolean>
Save the object to storage.

Returns Promise<boolean>
True on success, false on failure.
Implementation of EntityInterface.$save
- Defined in packages/client/src/Entity.ts:642

$serverCall

$serverCall(method, params, stateless?): Promise<any>
Call an instance method on the server version of this entity.

The entity's data will be sent up to the server as well, so the server's state can match the client's state. It won't be propagated into the DB, though.
Parameters
- method: string
  
  The name of the method.
- params: Iterable<any>
  
  The parameters to call the method with.
- stateless: boolean = false
  
  Whether the server should return, and the client update, the data in the entity after the method has run.
Returns Promise<any>
The value that the method on the server returned.
Implementation of EntityInterface.$serverCall
- Defined in packages/client/src/Entity.ts:649

$toReference

$toReference(): EntityReference | EntityInterface
Return a Nymph Entity Reference for this entity.

If the entity hasn't been saved yet (and has no GUID), it will be returned instead.

Returns EntityReference | EntityInterface
A Nymph Entity Reference array as an unsaved entity.
Implementation of EntityInterface.$toReference
- Defined in packages/client/src/Entity.ts:670

$wake

$wake(): Promise<Entity<T>>
Wake from a sleeping reference.

Returns Promise<Entity<T>>
Implementation of EntityInterface.$wake
- Defined in packages/client/src/Entity.ts:530

$wakeAll

$wakeAll(level?): Promise<Entity<T>>
Ready this entity's data, and the data of entity's within this one's.
Parameters
- Optional level: number
  
  The number of levels deep to wake. If undefined, it will keep going until there are no more entities. (Careful of infinite loops.)
Returns Promise<Entity<T>>
The entity.
Implementation of EntityInterface.$wakeAll
- Defined in packages/client/src/Entity.ts:560

toJSON

toJSON(): EntityJson
Returns EntityJson
- Defined in packages/client/src/Entity.ts:323

`Static` factory

factory(guid?): Promise<Entity<EntityData>>
Parameters
- Optional guid: string
Returns Promise<Entity<EntityData>>
- Defined in packages/client/src/Entity.ts:266

`Static` factoryReference

factoryReference(reference): Entity<EntityData>
Parameters
- reference: EntityReference
Returns Entity<EntityData>
- Defined in packages/client/src/Entity.ts:287

`Static` factorySync

factorySync(): Entity<EntityData>
Returns Entity<EntityData>
- Defined in packages/client/src/Entity.ts:283

`Static` serverCallStatic

serverCallStatic(method, params): Promise<any>
Parameters
- method: string
- params: Iterable<any>
Returns Promise<any>
- Defined in packages/client/src/Entity.ts:299

`Static` serverCallStaticIterator

serverCallStaticIterator(method, params): Promise<AbortableAsyncIterator<any>>
Parameters
- method: string
- params: Iterable<any>
Returns Promise<AbortableAsyncIterator<any>>
- Defined in packages/client/src/Entity.ts:310

Class Entity<T>

Type Parameters

T extends EntityData = EntityData

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends EntityData = EntityData

Returns Entity<T>

Properties

Protected $data

Protected $dataHandler

Protected $dataStore

Protected $dirty

Type declaration

[k: string]: boolean

Protected $isASleepingReference

$nymph

Protected $originalTags

Protected $sleepingReference

Protected $wakePromise

cdate

guid

mdate

tags

Static class

Static nymph

Methods

$addTag

Parameters

Rest ...tags: string[]

Returns void

$arraySearch

Parameters

array: any[]

strict: boolean = false

Returns number

$asleep

Returns boolean

Protected $check

Returns void

$delete

Returns Promise<boolean>

$equals

Parameters

object: any

Returns boolean

$getPatch

Returns EntityPatch

$hasTag

Parameters

Rest ...tags: string[]

Returns boolean

$inArray

Parameters

array: any[]

strict: boolean = false

Returns boolean

$init

Parameters

entityJson: null | EntityJson

Returns Entity<T>

$is

Parameters

object: any

Returns boolean

$patch

Returns Promise<boolean>

Protected $referenceSleep

Parameters

reference: EntityReference

Returns void

$refresh

Returns Promise<boolean | 0>

$removeTag

`Protected` $data

`Protected` $dataHandler

`Protected` $dataStore

`Protected` $dirty

`Protected` $isASleepingReference

`Protected` $originalTags

`Protected` $sleepingReference

`Protected` $wakePromise

`Static` class

`Static` nymph

`Rest` ...tags: string[]

`Protected` $check

`Rest` ...tags: string[]

`Protected` $referenceSleep

`Rest` ...tags: string[]

`Optional` level: number

`Static` factory

`Optional` guid: string

`Static` factoryReference

`Static` factorySync

`Static` serverCallStatic

`Static` serverCallStaticIterator