Class PubSub

Hierarchy

PubSub

Constructors

constructor

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

Properties

`Private` WebSocket

WebSocket: {
    CLOSED: 3;
    CLOSING: 2;
    CONNECTING: 0;
    OPEN: 1;
    prototype: WebSocket;
    new (url, protocols?): WebSocket;
}

Type declaration

- new (url, protocols?): WebSocket
- Parameters
  - url: string | URL
  - Optional protocols: string | string[]
  Returns WebSocket
Readonly CLOSED: 3
Readonly CLOSING: 2
Readonly CONNECTING: 0
Readonly OPEN: 1
prototype: WebSocket

`Private` authToken

authToken: null | string = null

`Private` connectCallbacks

connectCallbacks: PubSubConnectCallback[] = []

`Private` connection

connection: undefined | WebSocket

`Private` disconnectCallbacks

disconnectCallbacks: PubSubDisconnectCallback[] = []

`Private` errorCallbacks

errorCallbacks: PubSubErrorCallback[] = []

`Private` noConsole

noConsole: boolean = false

`Private` nymph

nymph: Nymph

`Private` pubsubUrl

pubsubUrl: undefined | string

`Private` subscriptions

subscriptions: {
    queries: {
        [k: string]: PubSubCallbacks<any>[];
    };
    uids: {
        [k: string]: PubSubCallbacks<number>[];
    };
} = ...

Type declaration

queries: {
[k: string]: PubSubCallbacks<any>[];
}
- [k: string]: PubSubCallbacks<any>[]
uids: {
[k: string]: PubSubCallbacks<number>[];
}
- [k: string]: PubSubCallbacks<number>[]

`Private` switchToken

switchToken: null | string = null

`Private` waitForConnectionTimeout

waitForConnectionTimeout: undefined | Timeout

Methods

`Private` _attemptConnect

_attemptConnect(): void
Returns void
- Defined in packages/client/src/PubSub.ts:290

`Private` _isCountSubscribedQuery

_isCountSubscribedQuery(query): boolean
Parameters
- query: string
Returns boolean
- Defined in packages/client/src/PubSub.ts:542

`Private` _isCountSubscribedUID

_isCountSubscribedUID(name): boolean
Parameters
- name: string
Returns boolean
- Defined in packages/client/src/PubSub.ts:558

`Private` _onclose

_onclose(e): void
Parameters
- e: CloseEvent
Returns void
- Defined in packages/client/src/PubSub.ts:441

`Private` _onmessage

_onmessage(e): void
Parameters
- e: MessageEvent<any>
Returns void
- Defined in packages/client/src/PubSub.ts:364

`Private` _onopen

_onopen(): void
Returns void
- Defined in packages/client/src/PubSub.ts:299

`Private` _send

_send(data): void
Parameters
- data: any
Returns void
- Defined in packages/client/src/PubSub.ts:463

`Private` _sendQuery

_sendQuery(query, count): void
Parameters
- query: string
- count: boolean
Returns void
- Defined in packages/client/src/PubSub.ts:526

`Private` _sendUID

_sendUID(name, count): void
Parameters
- name: string
- count: boolean
Returns void
- Defined in packages/client/src/PubSub.ts:534

`Private` _sendUnQuery

_sendUnQuery(query): void
Parameters
- query: string
Returns void
- Defined in packages/client/src/PubSub.ts:608

`Private` _sendUnUID

_sendUnUID(name): void
Parameters
- name: string
Returns void
- Defined in packages/client/src/PubSub.ts:615

`Private` _subscribeQuery

_subscribeQuery(query, callbacks): void
Parameters
- query: string
- callbacks: PubSubCallbacks<any>
Returns void
- Defined in packages/client/src/PubSub.ts:486

`Private` _subscribeUID

_subscribeUID(name, callbacks): void
Parameters
- name: string
- callbacks: PubSubCallbacks<number>
Returns void
- Defined in packages/client/src/PubSub.ts:506

`Private` _unsubscribeQuery

_unsubscribeQuery(query, callbacks): void
Parameters
- query: string
- callbacks: PubSubCallbacks<any>
Returns void
- Defined in packages/client/src/PubSub.ts:574

`Private` _unsubscribeUID

_unsubscribeUID(name, callbacks): void
Parameters
- name: string
- callbacks: PubSubCallbacks<number>
Returns void
- Defined in packages/client/src/PubSub.ts:591

`Private` _waitForConnection

_waitForConnection(attempts?): void
Parameters
- attempts: number = 1
Returns void
- Defined in packages/client/src/PubSub.ts:266

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?, reject?, count?) => {
unsubscribe: (() => void);
})
Parameters
- name: string
Returns ((resolve?, reject?, count?) => {
unsubscribe: (() => void);
})
- - (resolve?, reject?, count?): {
    unsubscribe: (() => void);
    }
  - Parameters
    - Optional resolve: PubSubResolveCallback<number>
    - Optional reject: PubSubRejectCallback
    - Optional count: 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
- Optional resolve: PubSubResolveCallback<T>
- Optional reject: PubSubRejectCallback
- Optional count: 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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

nymphOptions: NymphOptions

nymph: Nymph

Returns PubSub

Properties

Private WebSocket

Type declaration

Parameters

url: string | URL

Optional protocols: string | string[]

Returns WebSocket

Readonly CLOSED: 3

Readonly CLOSING: 2

Readonly CONNECTING: 0

Readonly OPEN: 1

prototype: WebSocket

Private authToken

Private connectCallbacks

Private connection

Private disconnectCallbacks

Private errorCallbacks

Private noConsole

Private nymph

Private pubsubUrl

Private subscriptions

Type declaration

queries: { [k: string]: PubSubCallbacks<any>[]; }

[k: string]: PubSubCallbacks<any>[]

uids: { [k: string]: PubSubCallbacks<number>[]; }

[k: string]: PubSubCallbacks<number>[]

Private switchToken

Private waitForConnectionTimeout

Methods

Private _attemptConnect

Returns void

Private _isCountSubscribedQuery

Parameters

query: string

Returns boolean

Private _isCountSubscribedUID

Parameters

name: string

Returns boolean

Private _onclose

Parameters

e: CloseEvent

Returns void

Private _onmessage

Parameters

e: MessageEvent<any>

Returns void

Private _onopen

Returns void

Private _send

Parameters

data: any

Returns void

Private _sendQuery

Parameters

query: string

count: boolean

Returns void

Private _sendUID

Parameters

name: string

count: boolean

Returns void

Private _sendUnQuery

Parameters

query: string

Returns void

Private _sendUnUID

`Private` WebSocket

`Optional` protocols: string | string[]

`Readonly` CLOSED: 3

`Readonly` CLOSING: 2

`Readonly` CONNECTING: 0

`Readonly` OPEN: 1

`Private` authToken

`Private` connectCallbacks

`Private` connection

`Private` disconnectCallbacks

`Private` errorCallbacks

`Private` noConsole

`Private` nymph

`Private` pubsubUrl

`Private` subscriptions

queries: {
[k: string]: PubSubCallbacks<any>[];
}

uids: {
[k: string]: PubSubCallbacks<number>[];
}

`Private` switchToken

`Private` waitForConnectionTimeout

`Private` _attemptConnect

`Private` _isCountSubscribedQuery

`Private` _isCountSubscribedUID

`Private` _onclose

`Private` _onmessage

`Private` _onopen

`Private` _send

`Private` _sendQuery

`Private` _sendUID

`Private` _sendUnQuery

`Private` _sendUnUID

`Private` _subscribeQuery

`Private` _subscribeUID

`Private` _unsubscribeQuery

`Private` _unsubscribeUID

`Private` _waitForConnection

callback: T extends "connect"
? PubSubConnectCallback
: T extends "disconnect"
? PubSubDisconnectCallback
: T extends "error"
? PubSubErrorCallback
: never

callback: T extends "connect"
? PubSubConnectCallback
: T extends "disconnect"
? PubSubDisconnectCallback
: T extends "error"
? PubSubErrorCallback
: never

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

`Rest` ...selectors: Selector[]

`Rest` ...selectors: Selector[]