Class GatewayEvent

One server frame that matters to an event source.

Index

Constructors

constructor

Properties

data model op

Constructors

constructor

new GatewayEvent(
    op: string,
    data: Readonly<Record<string, unknown>>,
    model?: unknown,
): GatewayEvent
Creates the event.
Parameters
- op: string
  The op.
- data: Readonly<Record<string, unknown>>
  The d member.
- Optionalmodel: unknown
  The typed reading of the frame, if any.
Returns GatewayEvent

Properties

`Readonly`data

data: Readonly<Record<string, unknown>>

The d member without null members (the envelope of a dispatch).

`Readonly`model

model: unknown

The frame read as its generated type (GatewayReady, GatewayResumed, GatewayCursor, GatewayResyncRequired), a GatewayOpError for error, undefined for dispatch.

`Readonly`op

op: string

dispatch, cursor, ready, resumed, resync_required or error.

Class GatewayEvent

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns GatewayEvent

Properties

`Readonly`data

`Readonly`model

`Readonly`op

Settings

On This Page

Class GatewayEvent

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns GatewayEvent

Properties

Readonlydata

Readonlymodel

Readonlyop

Settings

On This Page

`Readonly`data

`Readonly`model

`Readonly`op