Nymph.js 1.0.0-beta.113
    Preparing search index...

    Interface EntityInterface

    Entity interface.

    interface EntityInterface {
        $nymph: Nymph;
        cdate: number | null;
        guid: string | null;
        mdate: number | null;
        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:
                | EntityJson<EntityConstructor<EntityData, Entity<EntityData>>>
                | null,
        ): EntityInterface;
        $is(object: any): boolean;
        $isDirty(property: string): boolean | null;
        $patch(): Promise<boolean>;
        $refresh(): Promise<boolean | 0>;
        $removeTag(...tags: string[]): void;
        $save(): Promise<boolean>;
        $serverCall(
            method: string,
            params: Iterable<any>,
            stateless: boolean,
        ): Promise<any>;
        $toReference(): EntityReference | EntityInterface;
        $wake(): Promise<EntityInterface>;
        $wakeAll(level?: number): Promise<EntityInterface>;
        [k: string]: any;
    }

    Hierarchy (View Summary)

    Implemented by

    Indexable

    • [k: string]: any

      The object's data.

    Index

    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

    The instance of Nymph to use for queries.

    cdate: number | null

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

    guid: string | null

    The entity's Globally Unique ID.

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

    mdate: number | null

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

    tags: string[]

    Array of the entity's tags.

    Methods

    • Add one or more tags.

      Parameters

      • ...tags: string[]

        List of tags.

      Returns void

    • 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 the object from storage.

      Returns Promise<boolean>

      True on success, false on failure.

    • Perform a more strict comparison of this object to another.

      Parameters

      • object: any

        The object to compare.

      Returns boolean

      True or false.

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

      Returns EntityPatch

    • Check that the entity has all of the given tags.

      Parameters

      • ...tags: string[]

        List of tags.

      Returns boolean

      True or false.

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

    • Perform a less strict comparison of this object to another.

      Parameters

      • object: any

        The object to compare.

      Returns boolean

      True or false.

    • 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 boolean | null

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

    • Save the object's dirty data to storage.

      Returns Promise<boolean>

      True on success, false on failure.

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

    • Remove one or more tags.

      Parameters

      • ...tags: string[]

        List of tags.

      Returns void

    • Save the object to storage.

      Returns Promise<boolean>

      True on success, false on failure.

    • 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

        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.

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

    • Retrieve this entity's data from the server.

      Returns Promise<EntityInterface>

      The entity.

    • 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