Class Nymph

Hierarchy

Nymph

Constructors

constructor

new Nymph(NymphOptions): Nymph
Parameters
- NymphOptions: NymphOptions
Returns Nymph
- Defined in packages/client/src/Nymph.ts:56

Properties

Entity

Entity: typeof Entity

The entity class for this instance of Nymph.

cache

cache: default = ...

The entity cache.

`Private` entityClasses

entityClasses: {
[k: string]: EntityConstructor;
} = {}

A simple map of names to Entity classes.

Type declaration

[k: string]: EntityConstructor

headers

headers: {
[k: string]: string;
} = {}

Headers that will be sent with every request.

These are used by Tilmeld for authentication.

Type declaration

[k: string]: string

pubsub

pubsub: undefined | PubSub = undefined

And optional PubSub client instance.

`Private` requestCallbacks

requestCallbacks: RequestCallback[] = []

`Private` responseCallbacks

responseCallbacks: ResponseCallback[] = []

`Private` restUrl

restUrl: string = ''

`Private` weakCache

weakCache: boolean = false

Methods

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.
Type Parameters
- T extends EntityConstructor
Parameters
- entityClass: T
Returns T
- Defined in packages/client/src/Nymph.ts:94

deleteEntities

deleteEntities(entities): Promise<any>
Parameters
- entities: EntityInterface[]
Returns Promise<any>
- Defined in packages/client/src/Nymph.ts:492

deleteEntity

deleteEntity(entity, _plural?): Promise<any>
Parameters
- entity: EntityInterface | EntityInterface[]
- _plural: boolean = false
Returns Promise<any>
- Defined in packages/client/src/Nymph.ts:468

deleteUID

deleteUID(name): Promise<any>
Parameters
- name: string
Returns Promise<any>
- Defined in packages/client/src/Nymph.ts:153

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>
- Defined in packages/client/src/Nymph.ts:361
getEntities<T>(options, ...selectors): Promise<string[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "guid";
  }
- Rest ...selectors: Selector[]
Returns Promise<string[]>
- Defined in packages/client/src/Nymph.ts:365
getEntities<T>(options, ...selectors): Promise<EntityInstanceType<T>[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- Rest ...selectors: Selector[]
Returns Promise<EntityInstanceType<T>[]>
- Defined in packages/client/src/Nymph.ts:369

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>
- Defined in packages/client/src/Nymph.ts:256
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>
- Defined in packages/client/src/Nymph.ts:260
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>>
- Defined in packages/client/src/Nymph.ts:264
getEntity<T>(options, guid): Promise<number>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "count";
  }
- guid: string
Returns Promise<number>
- Defined in packages/client/src/Nymph.ts:268
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>
- Defined in packages/client/src/Nymph.ts:272
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>>
- Defined in packages/client/src/Nymph.ts:276

getEntityClass

getEntityClass<T>(className): T
Type Parameters
- T extends EntityConstructor
Parameters
- className: T
Returns T
- Defined in packages/client/src/Nymph.ts:107
getEntityClass(className): EntityConstructor
Parameters
- className: string
Returns EntityConstructor
- Defined in packages/client/src/Nymph.ts:108

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>
- Defined in packages/client/src/Nymph.ts:305
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>
- Defined in packages/client/src/Nymph.ts:309
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>>
- Defined in packages/client/src/Nymph.ts:313
getEntityData<T>(options, guid): Promise<number>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "count";
  }
- guid: string
Returns Promise<number>
- Defined in packages/client/src/Nymph.ts:317
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>
- Defined in packages/client/src/Nymph.ts:321
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>>
- Defined in packages/client/src/Nymph.ts:325

getEntityFromCache

getEntityFromCache<T>(EntityClass, guid): null | EntityInstanceType<T>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- EntityClass: EntityConstructor
- guid: string
Returns null | EntityInstanceType<T>
- Defined in packages/client/src/Nymph.ts:422

getUID

getUID(name): Promise<number>
Parameters
- name: string
Returns Promise<number>
- Defined in packages/client/src/Nymph.ts:143

initEntitiesFromData

initEntitiesFromData<T>(item): T
Type Parameters
- T extends unknown
Parameters
- item: T
Returns T
- Defined in packages/client/src/Nymph.ts:442

initEntity

initEntity<T>(entityJSON): EntityInstanceType<T>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- entityJSON: EntityJson<T>
Returns EntityInstanceType<T>
- Defined in packages/client/src/Nymph.ts:399

newUID

newUID(name): Promise<number>
Parameters
- name: string
Returns Promise<number>
- Defined in packages/client/src/Nymph.ts:124

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
- Defined in packages/client/src/Nymph.ts:605

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
- Defined in packages/client/src/Nymph.ts:584

patchEntities

patchEntities(entities): Promise<boolean | EntityInterface[]>
Parameters
- entities: EntityInterface[]
Returns Promise<boolean | EntityInterface[]>
- Defined in packages/client/src/Nymph.ts:198

patchEntity

patchEntity(entity): Promise<EntityInterface>
Parameters
- entity: EntityInterface
Returns Promise<EntityInterface>
- Defined in packages/client/src/Nymph.ts:187

`Private` requestWithMethod

requestWithMethod<T>(entity, method, data, plural): Promise<T>
Type Parameters
- T extends EntityInterface
Parameters
- entity: T
- method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"
- data: {
  [k: string]: any;
  }
  - [k: string]: any
- plural: false
Returns Promise<T>
- Defined in packages/client/src/Nymph.ts:215
requestWithMethod<T>(entity, method, data, plural): Promise<T[]>
Type Parameters
- T extends EntityInterface
Parameters
- entity: T[]
- method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"
- data: {
  [k: string]: any;
  }
  - [k: string]: any
- plural: true
Returns Promise<T[]>
- Defined in packages/client/src/Nymph.ts:221

saveEntities

saveEntities(entities): Promise<boolean | EntityInterface[]>
Parameters
- entities: EntityInterface[]
Returns Promise<boolean | EntityInterface[]>
- Defined in packages/client/src/Nymph.ts:167

saveEntity

saveEntity(entity): Promise<EntityInterface>
Parameters
- entity: EntityInterface
Returns Promise<EntityInterface>
- Defined in packages/client/src/Nymph.ts:162

serverCall

serverCall(entity, method, params, stateless?): Promise<ServerCallResponse>
Parameters
- entity: EntityInterface
- method: string
- params: any[]
- stateless: boolean = false
Returns Promise<ServerCallResponse>
- Defined in packages/client/src/Nymph.ts:496

serverCallStatic

serverCallStatic(className, method, params): Promise<any>
Parameters
- className: string
- method: string
- params: any[]
Returns Promise<any>
- Defined in packages/client/src/Nymph.ts:523

serverCallStaticIterator

serverCallStaticIterator(className, method, params): Promise<AbortableAsyncIterator<any>>
Parameters
- className: string
- method: string
- params: any[]
Returns Promise<AbortableAsyncIterator<any>>
- Defined in packages/client/src/Nymph.ts:546

setEntityToCache

setEntityToCache(EntityClass, entity): void
Parameters
- EntityClass: EntityConstructor
- entity: EntityInterface
Returns void
- Defined in packages/client/src/Nymph.ts:432

setUID

setUID(name, value): Promise<any>
Parameters
- name: string
- value: number
Returns Promise<any>
- Defined in packages/client/src/Nymph.ts:134

Class Nymph

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

NymphOptions: NymphOptions

Returns Nymph

Properties

Entity

cache

Private entityClasses

Type declaration

[k: string]: EntityConstructor

headers

Type declaration

[k: string]: string

pubsub

Private requestCallbacks

Private responseCallbacks

Private restUrl

Private weakCache

Methods

addEntityClass

Type Parameters

T extends EntityConstructor

Parameters

entityClass: T

Returns T

deleteEntities

Parameters

entities: EntityInterface[]

Returns Promise<any>

deleteEntity

Parameters

entity: EntityInterface | EntityInterface[]

_plural: boolean = false

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<EntityInstanceType<T>[]>

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

`Private` entityClasses

`Private` requestCallbacks

`Private` responseCallbacks

`Private` restUrl

`Private` weakCache

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";
}