Class PubSub

Hierarchy

default
- PubSub

Index

Constructors

Methods

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

Constructors

constructor

new PubSub(nymphOptions, nymph): PubSub
Parameters
- nymphOptions: NymphOptions
- nymph: default
Returns PubSub
Overrides PubSub.constructor
- Defined in client-node/src/index.ts:34

Methods

close

close(): void
Returns void
Inherited from PubSub.close
- Defined in client/lib/PubSub.d.ts:32

connect

connect(): void
Returns void
Inherited from PubSub.connect
- Defined in client/lib/PubSub.d.ts:31

isConnection

isConnection(): boolean
Returns boolean
Inherited from PubSub.isConnection
- Defined in client/lib/PubSub.d.ts:41

isConnectionConnecting

isConnectionConnecting(): boolean
Returns boolean
Inherited from PubSub.isConnectionConnecting
- Defined in client/lib/PubSub.d.ts:40

isConnectionOpen

isConnectionOpen(): boolean
Returns boolean
Inherited from PubSub.isConnectionOpen
- Defined in client/lib/PubSub.d.ts:39

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

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

setToken

setToken(authToken, switchToken?): void
Parameters
- authToken: null | string
- Optional switchToken: null | string
Returns void
Inherited from PubSub.setToken
- Defined in client/lib/PubSub.d.ts:55

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[]>>
Inherited from PubSub.subscribeEntities
- Defined in client/lib/PubSub.d.ts:19
subscribeEntities<T>(options, ...selectors): PubSubSubscribable<PubSubUpdate<ReturnType<T["factorySync"]>[]>>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- Rest ...selectors: Selector[]
Returns PubSubSubscribable<PubSubUpdate<ReturnType<T["factorySync"]>[]>>
Inherited from PubSub.subscribeEntities
- Defined in client/lib/PubSub.d.ts:22

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>>
Inherited from PubSub.subscribeEntity
- Defined in client/lib/PubSub.d.ts:23
subscribeEntity<T>(options, ...selectors): PubSubSubscribable<PubSubUpdate<null | ReturnType<T["factorySync"]>>>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- Rest ...selectors: Selector[]
Returns PubSubSubscribable<PubSubUpdate<null | ReturnType<T["factorySync"]>>>
Inherited from PubSub.subscribeEntity
- Defined in client/lib/PubSub.d.ts:26

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
Inherited from PubSub.subscribeUID
- Defined in client/lib/PubSub.d.ts:27

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>
Inherited from PubSub.subscribeWith
- Defined in client/lib/PubSub.d.ts:30

updateArray

updateArray(current, update): void
Parameters
- current: EntityInterface[]
- update: PubSubUpdate<EntityInterface[]>
Returns void
Inherited from PubSub.updateArray
- Defined in client/lib/PubSub.d.ts:52

Class PubSub

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

nymphOptions: NymphOptions

nymph: default

Returns PubSub

Methods

close

Returns void

connect

Returns void

isConnection

Returns boolean

isConnectionConnecting

Returns boolean

isConnectionOpen

Returns boolean

off

Type Parameters

T extends PubSubEventType

Parameters

event: T

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

Returns boolean

on

Type Parameters

T extends PubSubEventType

Parameters

event: T

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

Returns (() => boolean)

Returns boolean

setToken

Parameters

authToken: null | string

Optional switchToken: null | string

Returns void

subscribeEntities

Type Parameters

T extends EntityConstructor = EntityConstructor

Parameters

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

Rest ...selectors: Selector[]

Returns PubSubSubscribable<PubSubUpdate<string[]>>

Type Parameters

T extends EntityConstructor = EntityConstructor

Parameters

options: Options<T>

Rest ...selectors: Selector[]

Returns PubSubSubscribable<PubSubUpdate<ReturnType<T["factorySync"]>[]>>

subscribeEntity

Type Parameters

T extends EntityConstructor = EntityConstructor

Parameters

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

Rest ...selectors: Selector[]

Returns PubSubSubscribable<PubSubUpdate<null | string>>

Type Parameters

T extends EntityConstructor = EntityConstructor

Parameters

options: Options<T>

Rest ...selectors: Selector[]

Returns PubSubSubscribable<PubSubUpdate<null | ReturnType<T["factorySync"]>>>

subscribeUID

Parameters

name: string

Returns ((resolve?, reject?, count?) => { unsubscribe: (() => void); })

Parameters

Optional resolve: PubSubResolveCallback<number>

Optional reject: PubSubRejectCallback

Optional count: PubSubCountCallback

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

unsubscribe: (() => void)

Returns void

subscribeWith

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

`Optional` switchToken: null | string

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

`Rest` ...selectors: Selector[]

`Rest` ...selectors: Selector[]

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

`Rest` ...selectors: Selector[]

`Rest` ...selectors: Selector[]

Returns ((resolve?, reject?, count?) => {
unsubscribe: (() => void);
})

`Optional` resolve: PubSubResolveCallback<number>

`Optional` reject: PubSubRejectCallback

`Optional` count: PubSubCountCallback

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

`Optional` resolve: PubSubResolveCallback<T>

`Optional` reject: PubSubRejectCallback

`Optional` count: PubSubCountCallback