engine.io-parser
- Version 5.2.3
- Published
- 45.8 kB
- No dependencies
- MIT license
Install
npm i engine.io-parser
yarn add engine.io-parser
pnpm add engine.io-parser
Overview
Parser for the client for the realtime Engine
Index
Variables
variable protocol
const protocol: number;
Functions
function createPacketDecoderStream
createPacketDecoderStream: (maxPayload: number, binaryType: BinaryType) => any;
function createPacketEncoderStream
createPacketEncoderStream: () => any;
function decodePacket
decodePacket: (encodedPacket: RawData, binaryType?: BinaryType) => Packet;
function decodePayload
decodePayload: (encodedPayload: string, binaryType?: BinaryType) => Packet[];
function encodePacket
encodePacket: ( { type, data }: Packet, supportsBinary: boolean, callback: (encodedPacket: RawData) => void) => void;
function encodePayload
encodePayload: ( packets: Packet[], callback: (encodedPayload: string) => void) => void;
Interfaces
Type Aliases
type BinaryType
type BinaryType = 'nodebuffer' | 'arraybuffer' | 'blob';
type PacketType
type PacketType = | 'open' | 'close' | 'ping' | 'pong' | 'message' | 'upgrade' | 'noop' | 'error';
type RawData
type RawData = any;
Package Files (4)
Dependencies (0)
No dependencies.
Dev Dependencies (1)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/engine.io-parser
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/engine.io-parser)
- HTML<a href="https://www.jsdocs.io/package/engine.io-parser"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3313 ms. - Missing or incorrect documentation? Open an issue for this package.