method

bun.WebSocketHandler.message

ws: ServerWebSocket<T>,
message: string | Buffer<ArrayBuffer>
): void | Promise<void>;

Called when the server receives a message.

If the message is not a string, its type is based on the value of binaryType.

  • if nodebuffer, then the message is a Buffer.
  • if arraybuffer, then the message is an ArrayBuffer.
  • if uint8array, then the message is a Uint8Array.
  • if blob, then the message is a Blob.

The declared type of message is the one of the default binaryType.

@param ws

The websocket that sent the message

@param message

The message received

Referenced types

class ArrayBuffer

Represents a raw buffer of binary data, which is used to store data for the different typed arrays. ArrayBuffers cannot be read from or written to directly, but can be passed to a typed array or DataView Object to interpret the raw buffer as needed.

  • readonly [Symbol.toStringTag]: string
  • readonly byteLength: number

    Read-only. The length of the ArrayBuffer (in bytes).

  • newByteLength?: number
    ): void;

    Resizes the ArrayBuffer to the specified size (in bytes).

    MDN

    byteLength: number

    Resize an ArrayBuffer in-place.

  • begin: number,
    end?: number

    Returns a section of an ArrayBuffer.

  • newByteLength?: number

    Creates a new ArrayBuffer with the same byte content as this buffer, then detaches this buffer.

    MDN

  • newByteLength?: number

    Creates a new non-resizable ArrayBuffer with the same byte content as this buffer, then detaches this buffer.

    MDN