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;
    $clearCache(): void;
    $delete(): Promise<boolean>;
    $equals(object: any): boolean;
    $getClientEnabledMethods(): string[];
    $getCurrentAcValues(): ACProperties;
    $getData(includeSData?: boolean, referenceOnlyExisting?: boolean): EntityData;
    $getGuaranteedGUID(): string;
    $getOriginalAcValues(): ACProperties;
    $getSData(): SerializedEntityData;
    $getTags(): string[];
    $getUniques(): Promise<string[]>;
    $getValidatable(): Object;
    $hasTag(...tags: string[]): boolean;
    $inArray(array: any[], strict?: boolean): boolean;
    $is(object: any): boolean;
    $jsonAcceptData(input: EntityJson, allowConflict?: boolean): void;
    $jsonAcceptPatch(patch: EntityPatch, allowConflict?: boolean): void;
    $putData(data: EntityData, sdata?: SerializedEntityData, source?: "server"): void;
    $refresh(): Promise<boolean | 0>;
    $removeTag(...tags: string[]): void;
    $save(): Promise<boolean>;
    $toReference(existingOnly?: boolean): EntityInterface | EntityReference;
    $useSkipAc(useSkipAc: boolean): void;
}

Hierarchy (view full)

Implemented by

Properties

$nymph cdate guid mdate tags

Methods

$addTag $arraySearch $clearCache $delete $equals $getClientEnabledMethods $getCurrentAcValues $getData $getGuaranteedGUID $getOriginalAcValues $getSData $getTags $getUniques $getValidatable $hasTag $inArray $is $jsonAcceptData $jsonAcceptPatch $putData $refresh $removeTag $save $toReference $useSkipAc

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.

$clearCache

  • $clearCache(): void

  • Replace any referenced entities in the data with sleeping references.

    Calling this function ensures that the next time a referenced entity is accessed, it will be retrieved from the DB (unless it is in Nymph's cache).

    Returns void

$delete

$equals

$getClientEnabledMethods

  • $getClientEnabledMethods(): string[]

  • Get the client enabled methods.

    Returns string[]

    The names of methods allowed to be called by the frontend with serverCall.

$getCurrentAcValues

$getData

  • $getData(includeSData?, referenceOnlyExisting?): EntityData

  • Used to retrieve the data object.

    This should only be used by Nymph to save the data into storage.

    Parameters

    • OptionalincludeSData: boolean

      Whether to include the serialized data as well.

    • OptionalreferenceOnlyExisting: boolean

      Whether to only turn existing entities into references.

    Returns EntityData

    The entity's data object.

$getGuaranteedGUID

  • $getGuaranteedGUID(): string

  • Get a GUID for the entity.

    If the entity has already been saved, this will just return the GUID.

    If the entity has not yet been saved, this will return a new GUID that gets held by the entity. The guid property will remain null, but this method will then always return the same GUID. When the entity is eventually saved into the database, this GUID will be used.

    Returns string

$getOriginalAcValues

$getSData

  • $getSData(): SerializedEntityData

  • Used to retrieve the serialized data object.

    This should only be used by Nymph to save the data object into storage.

    This method is used by Nymph to avoid unserializing data that hasn't been requested yet.

    It should always be called after getData().

    Returns SerializedEntityData

    The entity's serialized data object.

$getTags

  • $getTags(): string[]

  • Get the entity's tags.

    Using this instead of accessing the tags prop directly will wake sleeping references.

    Returns string[]

    The entity's tags.

$getUniques

  • $getUniques(): Promise<string[]>

  • Get an array of strings that must be unique across the current etype.

    When you try to save another entity with any of the same unique strings, Nymph will throw an error.

    The default implementation of this method returns an empty array, meaning there are no uniqueness constraints applied to its etype.

    Returns Promise<string[]>

    Resolves to an array of entity's unique constraint strings.

$getValidatable

  • $getValidatable(): Object

  • Get an object that holds the same data as the entity.

    This provides an object that can be validated.

    Returns Object

    A pure object representation of the entity.

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

$is

$jsonAcceptData

  • $jsonAcceptData(input, allowConflict?): void

  • Accept JSON data from the client.

    This function uses the security protection lists:

    • $protectedTags
    • $protectedData
    • $allowlistTags
    • $allowlistData

    Parameters

    • input: EntityJson

      The input data. Please note, this will be modified (destroyed).

    • OptionalallowConflict: boolean

      Allow to accept data that is older than the current data.

    Returns void

$jsonAcceptPatch

  • $jsonAcceptPatch(patch, allowConflict?): void

  • Accept JSON patch from the client.

    This function uses the security protection lists:

    • $protectedTags
    • $protectedData
    • $allowlistTags
    • $allowlistData

    Parameters

    • patch: EntityPatch

      The patch data. Please note, this will be modified (destroyed).

    • OptionalallowConflict: boolean

      Allow to accept data that is older than the current data.

    Returns void

$putData

  • $putData(data, sdata?, source?): void

  • Used to set the data.

    This should only be used by Nymph to push the data from storage or the client.

    sdata is used by Nymph to avoid unserializing data that hasn't been requested yet.

    If source is set to "server", the data is coming from the DB or the cache. If not, assume the data is coming from the client and can't be trusted.

    Parameters

    • data: EntityData

      The data object.

    • Optionalsdata: SerializedEntityData

      The serialized data object.

    • Optionalsource: "server"

      If this is set to "server", the data is coming from the DB.

    Returns void

$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

$toReference

  • $toReference(existingOnly?): EntityInterface | EntityReference

  • Return a Nymph Entity Reference for this entity.

    If the entity hasn't been saved yet (and has no GUID), it will use the guaranteed GUID from $getGuaranteedGUID, unless existingOnly is true, then it will return the entity.

    Parameters

    • OptionalexistingOnly: boolean

      Whether to only turn existing entities into references.

    Returns EntityInterface | EntityReference

    A Nymph Entity Reference array.

$useSkipAc

  • $useSkipAc(useSkipAc): void

  • Set whether to use "skipAc" when accessing entity references.

    Parameters

    • useSkipAc: boolean

      True or false, whether to use it.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods