Class PubSub

Hierarchy (view full)

PubSub
- 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
Overrides PubSub.constructor
- Defined in client-node/src/index.ts:34

Methods

authenticate

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

close

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

connect

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

isConnection

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

isConnectionConnecting

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

isConnectionOpen

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

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:55

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:54

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:20
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>[]>>
Inherited from PubSub.subscribeEntities
- Defined in client/lib/PubSub.d.ts:23

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

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:28

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:31

updateArray

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

Class PubSub

Hierarchy (view full)

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?, reject?, count?) => { unsubscribe: (() => void); })

Parameters

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

unsubscribe: (() => void)

Returns void

subscribeWith

Type Parameters

Parameters

Returns PubSubSubscription<T>

updateArray

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

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

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