Class WebsocketTask

Opens and maintains a websocket for light speed data retrieval.

Input: None

Returns: String representation of the websocket subscription message.

Example: Opens a coinbase websocket

{ "websocketTask": { "url": "wss://ws-feed.pro.coinbase.com", "subscription": "{\"type\":\"subscribe\",\"product_ids\":[\"BTC-USD\"],\"channels\":[\"ticker\",{\"name\":\"ticker\",\"product_ids\":[\"BTC-USD\"]}]}", "maxDataAgeSeconds": 15, "filter": "$[?(@.type == 'ticker' && @.product_id == 'BTC-USD')]" } }

Implements

Constructors

constructor

Properties

filter maxDataAgeSeconds subscription url

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

  • new WebsocketTask(properties?: IWebsocketTask): WebsocketTask

    Constructs a new WebsocketTask.

    Parameters

    Returns WebsocketTask

Properties

filter

filter: string

Incoming message JSONPath filter. Example: "$[?(@.channel == 'ticker' && @.market == 'BTC/USD')]"

maxDataAgeSeconds

maxDataAgeSeconds: number

Minimum amount of time required between when the horses are taking out.

subscription

subscription: string

The websocket message to notify of a new subscription.

url

url: string

The websocket url.

Methods

toJSON

  • toJSON(): { [k: string]: any }

    Converts this WebsocketTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: IWebsocketTask): WebsocketTask

    Creates a new WebsocketTask instance using the specified properties.

    Parameters

    Returns WebsocketTask

    WebsocketTask instance

Staticdecode

  • decode(
        reader: Uint8Array<ArrayBufferLike> | Reader,
        length?: number,
    ): WebsocketTask

    Decodes a WebsocketTask message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    • Optionallength: number

      Message length if known beforehand

    Returns WebsocketTask

    WebsocketTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

  • decodeDelimited(reader: Uint8Array<ArrayBufferLike> | Reader): WebsocketTask

    Decodes a WebsocketTask message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns WebsocketTask

    WebsocketTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

  • encode(message: IWebsocketTask, writer?: Writer): Writer

    Encodes the specified WebsocketTask message. Does not implicitly verify messages.

    Parameters

    • message: IWebsocketTask

      WebsocketTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

  • encodeDelimited(message: IWebsocketTask, writer?: Writer): Writer

    Encodes the specified WebsocketTask message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IWebsocketTask

      WebsocketTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

  • fromObject(object: { [k: string]: any }): WebsocketTask

    Creates a WebsocketTask message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: { [k: string]: any }

      Plain object

    Returns WebsocketTask

    WebsocketTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for WebsocketTask

    Parameters

    Returns string

    The default type url

StatictoObject

  • toObject(
        message: WebsocketTask,
        options?: IConversionOptions,
    ): { [k: string]: any }

    Creates a plain object from a WebsocketTask message. Also converts values to other types if specified.

    Parameters

    • message: WebsocketTask

      WebsocketTask

    • Optionaloptions: IConversionOptions

      Conversion options

    Returns { [k: string]: any }

    Plain object

Staticverify

  • verify(message: { [k: string]: any }): string

    Verifies a WebsocketTask message.

    Parameters

    • message: { [k: string]: any }

      Plain object to verify

    Returns string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

On This Page

Constructors
Properties
Methods