function encodeFrameData
Since 0.2.0
encodeFrameData(data: string | Uint8Array): EncodedPayload

Encodes a WebSocket payload for the wire.

Text passes through unchanged; binary is base64-encoded, because a Uint8Array survives neither JSON.stringify nor a Redis pub/sub channel intact.

Examples

Example 1

encodeFrameData('hi');                        // { data: 'hi' }
encodeFrameData(new Uint8Array([1, 2, 3]));   // { data: 'AQID', binary: true }

Parameters

data: string | Uint8Array

The local payload

Return Type

The encoded payload

Usage

import { encodeFrameData } from "common/src/index.ts";