Class Entity<T>

constructor

• new Entity<T>(..._rest): Entity<T>

• Initialize an entity.

  Type Parameters

  • T extends EntityData = EntityData

  Parameters

  • Rest ..._rest: any[]

  Returns Entity<T>

$nymph

cdate

guid

mdate

tags

Static class

Static nymph

$addTag

• $addTag(...tags): void

• Add one or more tags.

  Parameters

  • Rest ...tags: string[]

    List of tags.

  Returns void

$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.

$asleep

• $asleep(): boolean

• Check if this is a sleeping reference.

  Returns boolean

$delete

• $delete(): Promise<boolean>

• Delete the object from storage.

  Returns Promise<boolean>

  True on success, false on failure.

$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.

$getPatch

• $getPatch(): EntityPatch

• Get a patch of this entity's dirty data to be applied on the server.

  Returns EntityPatch

$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.

$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.

$init

• $init(entityJson): Entity<T>

• Initialize this entity from a JSON representation.

  Parameters

  • entityJson: null | EntityJson

    The entity JSON.

  Returns Entity<T>

$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.

$patch

• $patch(): Promise<boolean>

• Save the object's dirty data to storage.

  Returns Promise<boolean>

  True on success, false on failure.

$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.

$removeTag

• $removeTag(...tags): void

• Remove one or more tags.

  Parameters

  • Rest ...tags: string[]

    List of tags.

  Returns void

$save

• $save(): Promise<boolean>

• Save the object to storage.

  Returns Promise<boolean>

  True on success, false on failure.

$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.

$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.

$wake

• $wake(): Promise<Entity<T>>

• Wake from a sleeping reference.

  Returns Promise<Entity<T>>

$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.

toJSON

• toJSON(): EntityJson

• Returns EntityJson

Static factory

• factory<E>(this, guid?): Promise<E & EntityDataType<E>>

• Create or retrieve a new entity instance.

  Note that this will always return an entity, even if the GUID is not found.

  Type Parameters

  • E extends Entity<EntityData>

  Parameters

  • this: (new () => E)
    • • new (): E

      • Returns E

  • Optional guid: string

    An optional GUID to retrieve.

  Returns Promise<E & EntityDataType<E>>

Static factoryReference

• factoryReference<E>(this, reference): E & EntityDataType<E>

• Create a new sleeping reference instance.

  Sleeping references won't retrieve their data from the server until they are readied with $wake() or a parent's $wakeAll().

  Type Parameters

  • E extends Entity<EntityData>

  Parameters

  • this: (new () => E)
    • • new (): E

      • Returns E

  • reference: EntityReference

    The Nymph Entity Reference to use to wake.

  Returns E & EntityDataType<E>

  The new instance.

Static factorySync

• factorySync<E>(this): E & EntityDataType<E>

• Create a new entity instance.

  Type Parameters

  • E extends Entity<EntityData>

  Parameters

  • this: (new () => E)
    • • new (): E

      • Returns E

  Returns E & EntityDataType<E>

Static serverCallStatic

• serverCallStatic(method, params): Promise<any>

• Call a static method on the server version of this entity.

  Parameters

  • method: string

    The name of the method.
  • params: Iterable<any>

    The parameters to call the method with.

  Returns Promise<any>

  The value that the method on the server returned.

Static serverCallStaticIterator

• serverCallStaticIterator(method, params): Promise<AbortableAsyncIterator<any>>

• Call a static iterator method on the server version of this entity.

  Parameters

  • method: string

    The name of the method.
  • params: Iterable<any>

    The parameters to call the method with.

  Returns Promise<AbortableAsyncIterator<any>>

  An iterator that iterates over values that the method on the server yields.