Class WebSocketSubscriptionAPI

Builds subscription messages as expected by the server to send over Websocket.

Example

const tradeSubscriptionParams = vertexClient.ws.subscription.buildSubscriptionParams('trade', ...);
const tradeSubscriptionMessage = vertexClient.ws.subscription.buildSubscriptionMessage(
   'subscribe', tradeSubscriptionParams);

Hierarchy (view full)

BaseVertexAPI
- WebSocketSubscriptionAPI

Index

Constructors

constructor

new WebSocketSubscriptionAPI(context): WebSocketSubscriptionAPI
Parameters
- context: VertexClientContext
Returns WebSocketSubscriptionAPI
Inherited from BaseVertexAPI.constructor
- Defined in apis/base.ts:12

Properties

`Readonly`context

context: VertexClientContext

Methods

buildSubscriptionMessage

buildSubscriptionMessage<TRequestType>(id, requestType, params): EngineServerSubscriptionRequest<TRequestType>
Builds a subscription request message as expected by the server via Websocket.
Type Parameters
- TRequestType extends keyof EngineServerSubscriptionRequestByType
Parameters
- id: number
  identifier to associate messages with responses.
- requestType: TRequestType
  name of request to build message for.
- params: EngineServerSubscriptionRequestByType[TRequestType]
  request message params.
Returns EngineServerSubscriptionRequest<TRequestType>
subscription request message.
- Defined in apis/ws/WebSocketSubscriptionAPI.ts:27

buildSubscriptionParams

buildSubscriptionParams<TStreamType>(streamType, params): {
stream: EngineServerSubscriptionStream<TStreamType>;
}
Builds a subscription stream param as expected by the server via Websocket.
Type Parameters
- TStreamType extends keyof EngineServerSubscriptionStreamParamsByType
Parameters
- streamType: TStreamType
  name of stream to build params for.
- params: EngineServerSubscriptionStreamParamsByType[TStreamType]
Returns {
stream: EngineServerSubscriptionStream<TStreamType>;
}
subscription stream params.
- stream: EngineServerSubscriptionStream<TStreamType>
- Defined in apis/ws/WebSocketSubscriptionAPI.ts:47

Class WebSocketSubscriptionAPI

Example

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebSocketSubscriptionAPI

Properties

`Readonly`context

Methods

buildSubscriptionMessage

Type Parameters

Parameters

Returns EngineServerSubscriptionRequest<TRequestType>

buildSubscriptionParams

Type Parameters

Parameters

Returns {
stream: EngineServerSubscriptionStream<TStreamType>;
}

stream: EngineServerSubscriptionStream<TStreamType>

Settings

On This Page

Class WebSocketSubscriptionAPI

Example

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebSocketSubscriptionAPI

Properties

Readonlycontext

Methods

buildSubscriptionMessage

Type Parameters

Parameters

Returns EngineServerSubscriptionRequest<TRequestType>

buildSubscriptionParams

Type Parameters

Parameters

Returns { stream: EngineServerSubscriptionStream<TStreamType>; }

stream: EngineServerSubscriptionStream<TStreamType>

Settings

On This Page

`Readonly`context

Returns {
stream: EngineServerSubscriptionStream<TStreamType>;
}