Nado Typescript SDK Documentation
    Preparing search index...

    Class WebSocketSubscriptionAPI

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

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    context

    Methods

    buildSubscriptionMessage buildSubscriptionParams

    Constructors

    Properties

    context: NadoClientContext

    Methods

    • 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.

    • 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.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods