# @types/msgpack5

> TypeScript definitions for msgpack5

Latest version **3.4.7** (published 2026-05-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/msgpack5
pnpm add @types/msgpack5
yarn add @types/msgpack5
bun add @types/msgpack5
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 3.4.7 |
| Published | 2026-05-02 |
| First published | 2016-11-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51438 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/msgpack5
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/msgpack5
- npm.io page: https://npm.io/package/@types/msgpack5

## Dependencies (3)

- [bl](https://npm.io/package/bl.md) >=5.1.0 <6.0.0
- [@types/node](https://npm.io/package/@types/node.md) *
- [@types/readable-stream](https://npm.io/package/@types/readable-stream.md) *

## Recent versions

- 3.4.7 (latest) — 2026-05-02
- 3.4.6 (ts4.5) — 2023-11-07
- 3.4.3 (ts4.1) — 2022-10-31
- 3.4.2 (ts3.6) — 2021-07-08
- 3.4.1 (ts2.0) — 2017-08-21
- 3.4.5 — 2023-10-18
- 3.4.4 — 2023-09-27
- 3.4.0 — 2016-11-16

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/msgpack5/index.d.ts)
````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: Sat, 02 May 2026 18:15:31 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [@types/readable-stream](https://npmjs.com/package/@types/readable-stream), [bl](https://npmjs.com/package/bl)

# Credits
These definitions were written by [Wonshik Kim](https://github.com/wokim), and [Kei Son](https://github.com/heycalmdown).

---
_Source: https://npm.io/package/@types/msgpack5 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._