Installation
npm install --save @types/msgpack5
Summary
This package contains type definitions for msgpack5 (https://github.com/mcollina/msgpack5/).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/msgpack5.
index.d.ts
import stream = require("stream");
import bl = require("bl");
interface MsgPackOptions {
forceFloat64?: boolean | undefined;
compatibilityMode?: boolean | undefined;
}
declare namespace msgpack5 {
interface EncodeDecodeOptions {
header?: boolean | undefined;
}
class Base extends stream.Transform {}
class Encoder extends Base {}
class Decoder extends Base {}
interface MessagePack {
encode(obj: any): bl;
decode(buf: Buffer): any;
decode(buf: bl): any;
register<T>(
type: number,
$constructor: any,
encode: (obj: T) => Buffer,
decode: (data: Buffer) => T,
): MessagePack;
registerEncoder<T>(check: (obj: T) => boolean, encode: (obj: T) => Buffer): MessagePack;
registerDecoder(type: number, decode: (data: Buffer) => any): MessagePack;
encoder(opts?: EncodeDecodeOptions): Encoder;
decoder(opts?: EncodeDecodeOptions): Decoder;
}
}
declare function msgpack5(opts?: MsgPackOptions): msgpack5.MessagePack;
export = msgpack5;
Additional Details
- Last updated: Tue, 07 Nov 2023 09:09:39 GMT
- Dependencies: @types/node, @types/readable-stream, bl
Credits
These definitions were written by Wonshik Kim, and Kei Son.