Interface EntityInterface

Entity interface.

interface EntityInterface {
    $nymph: Nymph;
    cdate: null | number;
    guid: null | string;
    mdate: null | number;
    tags: string[];
    $addTag(...tags: string[]): void;
    $arraySearch(array: any[], strict?: boolean): number;
    $delete(): Promise<boolean>;
    $equals(object: any): boolean;
    $getPatch(): EntityPatch;
    $hasTag(...tags: string[]): boolean;
    $inArray(array: any[], strict?: boolean): boolean;
    $init(entityJson: null | EntityJson<EntityConstructor<EntityData, Entity<EntityData>>>): EntityInterface;
    $is(object: any): boolean;
    $isDirty(property: string): null | boolean;
    $patch(): Promise<boolean>;
    $refresh(): Promise<boolean | 0>;
    $removeTag(...tags: string[]): void;
    $save(): Promise<boolean>;
    $serverCall(method: string, params: Iterable<any, any, any>, stateless: boolean): Promise<any>;
    $toReference(): EntityReference | EntityInterface;
    $wake(): Promise<EntityInterface>;
    $wakeAll(level?: number): Promise<EntityInterface>;
}

Hierarchy (view full)

Implemented by

Properties

$nymph cdate guid mdate tags

Methods

$addTag $arraySearch $delete $equals $getPatch $hasTag $inArray $init $is $isDirty $patch $refresh $removeTag $save $serverCall $toReference $wake $wakeAll

Properties

$nymph

$nymph: Nymph

The instance of Nymph to use for queries.

cdate

cdate: null | number

The creation date of the entity as a Unix timestamp in milliseconds.

guid

guid: null | string

The entity's Globally Unique ID.

This is a 12 byte number represented as a lower case HEX string (24 characters).

mdate

mdate: null | number

The modified date of the entity as a Unix timestamp in milliseconds.

tags

tags: string[]

Array of the entity's tags.

Methods

$addTag

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

    • Optionalstrict: boolean

      Whether to use stronger comparison.

    Returns number

    The index if the object is in the array, -1 if it isn't.

$delete

$equals

$getPatch

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

    • Optionalstrict: boolean

      Whether to use stronger comparison.

    Returns boolean

    True if the object is in the array, false if it isn't.

$init

$is

$isDirty

  • $isDirty(property): null | boolean

  • Check whether a property is dirty.

    To be a dirty property, it must have been set or deleted since the entity was initialized. A clean property existed on initialization and hasn't been set or deleted. An untracked property didn't exist on initialization and hasn't been set or deleted.

    Note that this doesn't necessarily mean the property has changed. It could have been set to the same value, or created and then deleted.

    Entities are initialized when they are pulled from the server or saved. This is done with the $init method.

    Parameters

    • property: string

      The name of a property.

    Returns null | boolean

    True if it's dirty, false if not, and null if it's not tracked.

$patch

$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

$save

$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, any, any>

      The parameters to call the method with.

    • stateless: boolean

      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

$wake

$wakeAll

  • $wakeAll(level?): Promise<EntityInterface>

  • Ready this entity's data, and the data of entity's within this one's.

    Parameters

    • Optionallevel: 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<EntityInterface>

    The entity.

Settings

Member Visibility

On This Page

Properties
Methods