Class Nymph

Hierarchy

default
- Nymph

Constructors

constructor

new Nymph(nymphOptions): Nymph
Parameters
- nymphOptions: NymphOptions
Returns Nymph
Overrides Nymph.constructor
- Defined in client-node/src/index.ts:8

Properties

Entity

Entity: typeof default

cache

cache: default

pubsub

pubsub: undefined | default

Methods

addEntityClass

addEntityClass<T>(entityClass): T
Type Parameters
- T extends EntityConstructor
Parameters
- entityClass: T
Returns T
Inherited from Nymph.addEntityClass
- Defined in client/lib/Nymph.d.ts:17

deleteEntities

deleteEntities(entities): Promise<any>
Parameters
- entities: EntityInterface[]
Returns Promise<any>
Inherited from Nymph.deleteEntities
- Defined in client/lib/Nymph.d.ts:69

deleteEntity

deleteEntity(entity, _plural?): Promise<any>
Parameters
- entity: EntityInterface | EntityInterface[]
- Optional _plural: boolean
Returns Promise<any>
Inherited from Nymph.deleteEntity
- Defined in client/lib/Nymph.d.ts:68

deleteUID

deleteUID(name): Promise<any>
Parameters
- name: string
Returns Promise<any>
Inherited from Nymph.deleteUID
- Defined in client/lib/Nymph.d.ts:23

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>
Inherited from Nymph.getEntities
- Defined in client/lib/Nymph.d.ts:57
getEntities<T>(options, ...selectors): Promise<string[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "guid";
  }
- Rest ...selectors: Selector[]
Returns Promise<string[]>
Inherited from Nymph.getEntities
- Defined in client/lib/Nymph.d.ts:60
getEntities<T>(options, ...selectors): Promise<ReturnType<T["factorySync"]>[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- Rest ...selectors: Selector[]
Returns Promise<ReturnType<T["factorySync"]>[]>
Inherited from Nymph.getEntities
- Defined in client/lib/Nymph.d.ts:63

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>
Inherited from Nymph.getEntity
- Defined in client/lib/Nymph.d.ts:29
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>
Inherited from Nymph.getEntity
- Defined in client/lib/Nymph.d.ts:32
getEntity<T>(options, ...selectors): Promise<null | ReturnType<T["factorySync"]>>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- Rest ...selectors: Selector[]
Returns Promise<null | ReturnType<T["factorySync"]>>
Inherited from Nymph.getEntity
- Defined in client/lib/Nymph.d.ts:35
getEntity<T>(options, guid): Promise<number>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "count";
  }
- guid: string
Returns Promise<number>
Inherited from Nymph.getEntity
- Defined in client/lib/Nymph.d.ts:36
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>
Inherited from Nymph.getEntity
- Defined in client/lib/Nymph.d.ts:39
getEntity<T>(options, guid): Promise<null | ReturnType<T["factorySync"]>>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- guid: string
Returns Promise<null | ReturnType<T["factorySync"]>>
Inherited from Nymph.getEntity
- Defined in client/lib/Nymph.d.ts:42

getEntityClass

getEntityClass<T>(className): T
Type Parameters
- T extends EntityConstructor
Parameters
- className: T
Returns T
Inherited from Nymph.getEntityClass
- Defined in client/lib/Nymph.d.ts:18
getEntityClass(className): EntityConstructor
Parameters
- className: string
Returns EntityConstructor
Inherited from Nymph.getEntityClass
- Defined in client/lib/Nymph.d.ts:19

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>
Inherited from Nymph.getEntityData
- Defined in client/lib/Nymph.d.ts:43
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>
Inherited from Nymph.getEntityData
- Defined in client/lib/Nymph.d.ts:46
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>>
Inherited from Nymph.getEntityData
- Defined in client/lib/Nymph.d.ts:49
getEntityData<T>(options, guid): Promise<number>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "count";
  }
- guid: string
Returns Promise<number>
Inherited from Nymph.getEntityData
- Defined in client/lib/Nymph.d.ts:50
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>
Inherited from Nymph.getEntityData
- Defined in client/lib/Nymph.d.ts:53
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>>
Inherited from Nymph.getEntityData
- Defined in client/lib/Nymph.d.ts:56

getEntityFromCache

getEntityFromCache<T>(EntityClass, guid): null | ReturnType<T["factorySync"]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- EntityClass: EntityConstructor
- guid: string
Returns null | ReturnType<T["factorySync"]>
Inherited from Nymph.getEntityFromCache
- Defined in client/lib/Nymph.d.ts:65

getUID

getUID(name): Promise<number>
Parameters
- name: string
Returns Promise<number>
Inherited from Nymph.getUID
- Defined in client/lib/Nymph.d.ts:22

initEntitiesFromData

initEntitiesFromData<T>(item): T
Type Parameters
- T extends unknown
Parameters
- item: T
Returns T
Inherited from Nymph.initEntitiesFromData
- Defined in client/lib/Nymph.d.ts:67

initEntity

initEntity<T>(entityJSON): ReturnType<T["factorySync"]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- entityJSON: EntityJson<T>
Returns ReturnType<T["factorySync"]>
Inherited from Nymph.initEntity
- Defined in client/lib/Nymph.d.ts:64

newUID

newUID(name): Promise<number>
Parameters
- name: string
Returns Promise<number>
Inherited from Nymph.newUID
- Defined in client/lib/Nymph.d.ts:20

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
Inherited from Nymph.off
- Defined in client/lib/Nymph.d.ts:74

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
Inherited from Nymph.on
- Defined in client/lib/Nymph.d.ts:73

patchEntities

patchEntities(entities): Promise<boolean | EntityInterface[]>
Parameters
- entities: EntityInterface[]
Returns Promise<boolean | EntityInterface[]>
Inherited from Nymph.patchEntities
- Defined in client/lib/Nymph.d.ts:27

patchEntity

patchEntity(entity): Promise<EntityInterface>
Parameters
- entity: EntityInterface
Returns Promise<EntityInterface>
Inherited from Nymph.patchEntity
- Defined in client/lib/Nymph.d.ts:26

saveEntities

saveEntities(entities): Promise<boolean | EntityInterface[]>
Parameters
- entities: EntityInterface[]
Returns Promise<boolean | EntityInterface[]>
Inherited from Nymph.saveEntities
- Defined in client/lib/Nymph.d.ts:25

saveEntity

saveEntity(entity): Promise<EntityInterface>
Parameters
- entity: EntityInterface
Returns Promise<EntityInterface>
Inherited from Nymph.saveEntity
- Defined in client/lib/Nymph.d.ts:24

serverCall

serverCall(entity, method, params, stateless?): Promise<ServerCallResponse>
Parameters
- entity: EntityInterface
- method: string
- params: any[]
- Optional stateless: boolean
Returns Promise<ServerCallResponse>
Inherited from Nymph.serverCall
- Defined in client/lib/Nymph.d.ts:70

serverCallStatic

serverCallStatic(className, method, params): Promise<any>
Parameters
- className: string
- method: string
- params: any[]
Returns Promise<any>
Inherited from Nymph.serverCallStatic
- Defined in client/lib/Nymph.d.ts:71

serverCallStaticIterator

serverCallStaticIterator(className, method, params): Promise<AbortableAsyncIterator<any>>
Parameters
- className: string
- method: string
- params: any[]
Returns Promise<AbortableAsyncIterator<any>>
Inherited from Nymph.serverCallStaticIterator
- Defined in client/lib/Nymph.d.ts:72

setEntityToCache

setEntityToCache(EntityClass, entity): void
Parameters
- EntityClass: EntityConstructor
- entity: EntityInterface
Returns void
Inherited from Nymph.setEntityToCache
- Defined in client/lib/Nymph.d.ts:66

setUID

setUID(name, value): Promise<any>
Parameters
- name: string
- value: number
Returns Promise<any>
Inherited from Nymph.setUID
- Defined in client/lib/Nymph.d.ts:21

setXsrfToken

setXsrfToken(token): void
Parameters
- token: null | string
Returns void
Inherited from Nymph.setXsrfToken
- Defined in client/lib/Nymph.d.ts:75

Class Nymph

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

nymphOptions: NymphOptions

Returns Nymph

Properties

Entity

cache

pubsub

Methods

addEntityClass

Type Parameters

T extends EntityConstructor

Parameters

entityClass: T

Returns T

deleteEntities

Parameters

entities: EntityInterface[]

Returns Promise<any>

deleteEntity

Parameters

entity: EntityInterface | EntityInterface[]

Optional _plural: boolean

Returns Promise<any>

deleteUID

Parameters

name: string

Returns Promise<any>

getEntities

Type Parameters

T extends EntityConstructor = EntityConstructor

Parameters

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

Rest ...selectors: Selector[]

Returns Promise<number>

Type Parameters

T extends EntityConstructor = EntityConstructor

Parameters

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

Rest ...selectors: Selector[]

Returns Promise<string[]>

Type Parameters

T extends EntityConstructor = EntityConstructor

Parameters

options: Options<T>

Rest ...selectors: Selector[]

Returns Promise<ReturnType<T["factorySync"]>[]>

getEntity

Type Parameters

T extends EntityConstructor = EntityConstructor

Parameters

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

Rest ...selectors: Selector[]

Returns Promise<number>

Type Parameters

T extends EntityConstructor = EntityConstructor

Parameters

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

Rest ...selectors: Selector[]

Returns Promise<null | string>

Type Parameters

T extends EntityConstructor = EntityConstructor

Parameters

options: Options<T>

Rest ...selectors: Selector[]

Returns Promise<null | ReturnType<T["factorySync"]>>

Type Parameters

T extends EntityConstructor = EntityConstructor

Parameters

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

guid: string

Returns Promise<number>

Type Parameters

`Optional` _plural: boolean

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

`Rest` ...selectors: Selector[]

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

`Rest` ...selectors: Selector[]

`Rest` ...selectors: Selector[]

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

`Rest` ...selectors: Selector[]

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

`Rest` ...selectors: Selector[]

`Rest` ...selectors: Selector[]

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

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

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

`Rest` ...selectors: Selector[]

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

`Rest` ...selectors: Selector[]

`Rest` ...selectors: Selector[]

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

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