Class Nymph

constructor

• new Nymph(NymphOptions): Nymph

• Parameters

  • NymphOptions: NymphOptions

  Returns Nymph

cache

Entity

headers

pubsub

returnNullOnNotFound

addEntityClass

• addEntityClass<T>(entityClass): T

• Add your class to this instance.

  This will create a class that extends your class within this instance of Nymph and return it. You can then use this class's constructor and methods, which will use this instance of Nymph.

  Because this creates a subclass, don't use the class returned from getEntityClass to check with instanceof. Instead, use the base class that you passed into this method.

  Type Parameters

  • T extends EntityConstructor

  Parameters

  • entityClass: T

  Returns T

deleteEntities

• deleteEntities(entities): Promise<any>

• Parameters

  • entities: EntityInterface[]

  Returns Promise<any>

deleteEntity

• deleteEntity(entity, _plural?): Promise<any>

• Parameters

  • entity: EntityInterface | EntityInterface[]
  • _plural: boolean = false

  Returns Promise<any>

deleteUID

• deleteUID(name): Promise<any>

• Parameters

  • name: string

  Returns Promise<any>

getEntities

• getEntities<T>(options, ...selectors): Promise<number>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "count";
    }
  • Rest...selectors: Selector[]

  Returns Promise<number>

• getEntities<T>(options, ...selectors): Promise<string[]>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "guid";
    }
  • Rest...selectors: Selector[]

  Returns Promise<string[]>

• getEntities<T>(options, ...selectors): Promise<EntityInstanceType<T>[]>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T>
  • Rest...selectors: Selector[]

  Returns Promise<EntityInstanceType<T>[]>

getEntity

• getEntity<T>(options, ...selectors): Promise<number>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "count";
    }
  • Rest...selectors: Selector[]

  Returns Promise<number>

• getEntity<T>(options, ...selectors): Promise<null | string>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "guid";
    }
  • Rest...selectors: Selector[]

  Returns Promise<null | string>

• getEntity<T>(options, ...selectors): Promise<null | EntityInstanceType<T>>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T>
  • Rest...selectors: Selector[]

  Returns Promise<null | EntityInstanceType<T>>

• getEntity<T>(options, guid): Promise<number>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "count";
    }
  • guid: string

  Returns Promise<number>

• getEntity<T>(options, guid): Promise<null | string>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "guid";
    }
  • guid: string

  Returns Promise<null | string>

• getEntity<T>(options, guid): Promise<null | EntityInstanceType<T>>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T>
  • guid: string

  Returns Promise<null | EntityInstanceType<T>>

getEntityClass

• getEntityClass<T>(className): T

• Type Parameters

  • T extends EntityConstructor

  Parameters

  • className: T

  Returns T

• getEntityClass(className): EntityConstructor

• Parameters

  • className: string

  Returns EntityConstructor

getEntityData

• getEntityData<T>(options, ...selectors): Promise<number>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "count";
    }
  • Rest...selectors: Selector[]

  Returns Promise<number>

• getEntityData<T>(options, ...selectors): Promise<null | string>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "guid";
    }
  • Rest...selectors: Selector[]

  Returns Promise<null | string>

• getEntityData<T>(options, ...selectors): Promise<null | EntityJson<T>>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T>
  • Rest...selectors: Selector[]

  Returns Promise<null | EntityJson<T>>

• getEntityData<T>(options, guid): Promise<number>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "count";
    }
  • guid: string

  Returns Promise<number>

• getEntityData<T>(options, guid): Promise<null | string>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "guid";
    }
  • guid: string

  Returns Promise<null | string>

• getEntityData<T>(options, guid): Promise<null | EntityJson<T>>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T>
  • guid: string

  Returns Promise<null | EntityJson<T>>

getEntityFromCache

• getEntityFromCache<T>(EntityClass, guid): null | EntityInstanceType<T>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • EntityClass: EntityConstructor
  • guid: string

  Returns null | EntityInstanceType<T>

getUID

• getUID(name): Promise<number>

• Parameters

  • name: string

  Returns Promise<number>

initEntitiesFromData

• initEntitiesFromData<T>(item): T

• Type Parameters

  • T extends unknown

  Parameters

  • item: T

  Returns T

initEntity

• initEntity<T>(entityJSON): EntityInstanceType<T>

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • entityJSON: EntityJson<T>

  Returns EntityInstanceType<T>

newUID

• newUID(name): Promise<number>

• Parameters

  • name: string

  Returns Promise<number>

off

• off<T>(event, callback): boolean

• Type Parameters

  • T extends EventType

  Parameters

  • event: T
  • callback: T extends "request"
        ? RequestCallback
        : T extends "response"
            ? ResponseCallback
            : never

  Returns boolean

on

• on<T>(event, callback): (() => boolean)

• Type Parameters

  • T extends EventType

  Parameters

  • event: T
  • callback: T extends "request"
        ? RequestCallback
        : T extends "response"
            ? ResponseCallback
            : never

  Returns (() => boolean)

  • • (): boolean

    • Returns boolean

patchEntities

• patchEntities(entities): Promise<boolean | EntityInterface[]>

• Parameters

  • entities: EntityInterface[]

  Returns Promise<boolean | EntityInterface[]>

patchEntity

• patchEntity(entity): Promise<EntityInterface>

• Parameters

  • entity: EntityInterface

  Returns Promise<EntityInterface>

saveEntities

• saveEntities(entities): Promise<boolean | EntityInterface[]>

• Parameters

  • entities: EntityInterface[]

  Returns Promise<boolean | EntityInterface[]>

saveEntity

• saveEntity(entity): Promise<EntityInterface>

• Parameters

  • entity: EntityInterface

  Returns Promise<EntityInterface>

serverCall

• serverCall(entity, method, params, stateless?): Promise<ServerCallResponse>

• Parameters

  • entity: EntityInterface
  • method: string
  • params: any[]
  • stateless: boolean = false

  Returns Promise<ServerCallResponse>

serverCallStatic

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

• Parameters

  • className: string
  • method: string
  • params: any[]

  Returns Promise<any>

serverCallStaticIterator

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

• Parameters

  • className: string
  • method: string
  • params: any[]

  Returns Promise<AbortableAsyncIterator<any>>

setEntityToCache

• setEntityToCache(EntityClass, entity): void

• Parameters

  • EntityClass: EntityConstructor
  • entity: EntityInterface

  Returns void

setUID

• setUID(name, value): Promise<any>

• Parameters

  • name: string
  • value: number

  Returns Promise<any>