Class PubSub

Index

Constructors

Methods

authenticate close connect isConnection isConnectionConnecting isConnectionOpen off on subscribeEntities subscribeEntity subscribeUID subscribeWith updateArray

Constructors

constructor

new PubSub(nymphOptions, nymph): PubSub
Parameters
- nymphOptions: NymphOptions
- nymph: Nymph
Returns PubSub
- Defined in packages/client/src/PubSub.ts:48

Methods

authenticate

authenticate(authToken, switchToken?): void
Parameters
- authToken: null | string
- switchToken: null | string = null
Returns void
- Defined in packages/client/src/PubSub.ts:787

close

close(): void
Returns void
- Defined in packages/client/src/PubSub.ts:255

connect

connect(): void
Returns void
- Defined in packages/client/src/PubSub.ts:241

isConnection

isConnection(): boolean
Returns boolean
- Defined in packages/client/src/PubSub.ts:482

isConnectionConnecting

isConnectionConnecting(): boolean
Returns boolean
- Defined in packages/client/src/PubSub.ts:475

isConnectionOpen

isConnectionOpen(): boolean
Returns boolean
- Defined in packages/client/src/PubSub.ts:469

off

off<T>(event, callback): boolean
Type Parameters
- T extends PubSubEventType
Parameters
- event: T
- callback: T extends "connect"
      ? PubSubConnectCallback
      : T extends "disconnect"
          ? PubSubDisconnectCallback
          : T extends "error"
              ? PubSubErrorCallback
              : never
Returns boolean
- Defined in packages/client/src/PubSub.ts:759

on

on<T>(event, callback): (() => boolean)
Type Parameters
- T extends PubSubEventType
Parameters
- event: T
- callback: T extends "connect"
      ? PubSubConnectCallback
      : T extends "disconnect"
          ? PubSubDisconnectCallback
          : T extends "error"
              ? PubSubErrorCallback
              : never
Returns (() => boolean)
- - (): boolean
  - Returns boolean
- Defined in packages/client/src/PubSub.ts:734

subscribeEntities

subscribeEntities<T>(options, ...selectors): PubSubSubscribable<PubSubUpdate<string[]>>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "guid";
  }
- Rest...selectors: Selector[]
Returns PubSubSubscribable<PubSubUpdate<string[]>>
- Defined in packages/client/src/PubSub.ts:72
subscribeEntities<T>(options, ...selectors): PubSubSubscribable<PubSubUpdate<EntityInstanceType<T>[]>>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- Rest...selectors: Selector[]
Returns PubSubSubscribable<PubSubUpdate<EntityInstanceType<T>[]>>
- Defined in packages/client/src/PubSub.ts:76

subscribeEntity

subscribeEntity<T>(options, ...selectors): PubSubSubscribable<PubSubUpdate<null | string>>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "guid";
  }
- Rest...selectors: Selector[]
Returns PubSubSubscribable<PubSubUpdate<null | string>>
- Defined in packages/client/src/PubSub.ts:119
subscribeEntity<T>(options, ...selectors): PubSubSubscribable<PubSubUpdate<null | EntityInstanceType<T>>>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- Rest...selectors: Selector[]
Returns PubSubSubscribable<PubSubUpdate<null | EntityInstanceType<T>>>
- Defined in packages/client/src/PubSub.ts:123

subscribeUID

subscribeUID(name): ((resolve?: PubSubResolveCallback<number>, reject?: PubSubRejectCallback, count?: PubSubCountCallback) => {
unsubscribe: (() => void);
})
Parameters
- name: string
Returns ((resolve?: PubSubResolveCallback<number>, reject?: PubSubRejectCallback, count?: PubSubCountCallback) => {
unsubscribe: (() => void);
})
- - (resolve?, reject?, count?): {
    unsubscribe: (() => void);
    }
  - Parameters
    - Optionalresolve: PubSubResolveCallback<number>
    - Optionalreject: PubSubRejectCallback
    - Optionalcount: PubSubCountCallback
    Returns {
    unsubscribe: (() => void);
    }
    - unsubscribe: (() => void)
      - (): void
        Returns void
- Defined in packages/client/src/PubSub.ts:176

subscribeWith

subscribeWith<T>(entity, resolve?, reject?, count?): PubSubSubscription<T>
Type Parameters
- T extends EntityInterface
Parameters
- entity: T
- Optionalresolve: PubSubResolveCallback<T>
- Optionalreject: PubSubRejectCallback
- Optionalcount: PubSubCountCallback
Returns PubSubSubscription<T>
- Defined in packages/client/src/PubSub.ts:199

updateArray

updateArray(current, update): void
Parameters
- current: EntityInterface[]
- update: PubSubUpdate<EntityInterface[]>
Returns void
- Defined in packages/client/src/PubSub.ts:622

Class PubSub

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PubSub

Methods

authenticate

Parameters

Returns void

close

Returns void

connect

Returns void

isConnection

Returns boolean

isConnectionConnecting

Returns boolean

isConnectionOpen

Returns boolean

off

Type Parameters

Parameters

Returns boolean

on

Type Parameters

Parameters

Returns (() => boolean)

Returns boolean

subscribeEntities

Type Parameters

Parameters

Returns PubSubSubscribable<PubSubUpdate<string[]>>

Type Parameters

Parameters

Returns PubSubSubscribable<PubSubUpdate<EntityInstanceType<T>[]>>

subscribeEntity

Type Parameters

Parameters

Returns PubSubSubscribable<PubSubUpdate<null | string>>

Type Parameters

Parameters

Returns PubSubSubscribable<PubSubUpdate<null | EntityInstanceType<T>>>

subscribeUID

Parameters

Returns ((resolve?: PubSubResolveCallback<number>, reject?: PubSubRejectCallback, count?: PubSubCountCallback) => { unsubscribe: (() => void); })

Parameters

Returns { unsubscribe: (() => void); }

unsubscribe: (() => void)

Returns void

subscribeWith

Type Parameters

Parameters

Returns PubSubSubscription<T>

updateArray

Parameters

Returns void

Settings

On This Page

Returns ((resolve?: PubSubResolveCallback<number>, reject?: PubSubRejectCallback, count?: PubSubCountCallback) => {
unsubscribe: (() => void);
})

Returns {
unsubscribe: (() => void);
}