Type Alias WsMessage

Type Declaration

• { data: string; type: "text"; json<T = unknown>(): T; text(): string }

  • data: string

  • type: "text"

  • json: function

    • json<T = unknown>(): T

      Parses the text payload as JSON.

      Type Parameters

      • T = unknown

        The expected shape of the decoded value.

      Returns T

      The parsed value.

      Throws

      If the text is not valid JSON.

      Since

      1.0.2

  • text: function

    • text(): string

      Returns the message as text (the identity for a text frame).

      Present on both frame types so msg.text() works without branching on type.

      Returns string

      The text payload.

      Since

      1.0.4

• { data: Uint8Array; type: "binary"; json<T = unknown>(): T; text(): string }

  • data: Uint8Array

  • type: "binary"

  • json: function

    • json<T = unknown>(): T

      Decodes the binary payload as UTF-8 and parses it as JSON.

      Type Parameters

      • T = unknown

        The expected shape of the decoded value.

      Returns T

      The parsed value.

      Throws

      If the decoded payload is not valid JSON.

      Since

      1.0.4

  • text: function

    • text(): string

      Decodes the binary payload as UTF-8 text.

      Present on both frame types so msg.text() works without branching on type - handy for servers that send JSON or text over binary frames.

      Returns string

      The payload decoded as UTF-8.

      Since

      1.0.4