Variable MsgPackConst

MsgPack: unknown

Provides a BaseRest or BaseRealtime instance with the ability to communicate with the Ably service using the more space-efficient MessagePack format.

To create a client that includes this plugin, include it in the client options that you pass to the constructor:

import { BaseRealtime, WebSocketTransport, FetchRequest, MsgPack } from 'ably/modular';
const realtime = new BaseRealtime({ ...options, plugins: { WebSocketTransport, FetchRequest, MsgPack } });

When provided, you can control whether the client uses MessagePack via the useBinaryProtocol client option. If you do not provide this plugin, then the library will always JSON format for encoding messages.

Generated using TypeDoc