Small & fast msgpack serialization & deserialization
npm install @thi.ng/msgpack
!npm downloads
> [!NOTE]
> This is one of 214 standalone projects, maintained as part
> of the @thi.ng/umbrella monorepo
> and anti-framework.
>
> 🚀 Please help me to work full-time on these projects by sponsoring me on
> GitHub. Thank you! ❤️
- About
- Supported values
- Status
- Installation
- Dependencies
- API
- Authors
- License
Small & fast msgpack serialization & deserialization.
This implementation is a full rewrite & refactor of
@ygoe/msgpack.js, based on this
specification.
- numbers (i8/16/32, u8/16/32, bigint signed/unsigned 64bit range, floats)
- strings (converted to UTF-8)
- plain JS objects
- arrays
- typed arrays (as bytes)
- Date objects
- null
Custom types can be serialized via a user-provided resolve() function which is
expected to produce a msgpack-compatible representation of the custom type(s).
As with JSON.stringify(), undefined values will be serialized as null and
object keys with undefined will be entirely omitted in the serialization.
ALPHA - bleeding edge / work-in-progress
Search or submit any issues for this package
``bash`
yarn add @thi.ng/msgpack
ESM import:
`ts`
import * as msg from "@thi.ng/msgpack";
Browser ESM import:
`html`
For Node.js REPL:
`js`
const msg = await import("@thi.ng/msgpack");
Package sizes (brotli'd, pre-treeshake): ESM: 1.56 KB
- @thi.ng/checks
- @thi.ng/errors
- @thi.ng/strings
`ts tangle:export/readme.ts
import { deserialize, serialize } from "@thi.ng/msgpack";
import { equiv } from "@thi.ng/equiv";
const obj = {
small_i8: -0x0f,
i8: -0x80,
small_u8: 0xff,
i16: -0x8000,
u16: 0xfedc,
i32: -0x8000_0000,
u32: 0xffff_ffff,
utf8_array: ["👋 Hello", "msgpack!", "🔥🤌"],
now: new Date()
};
// encode to byte array
const bytes = serialize(obj);
console.log(bytes);
// Uint8Array(114) [ 137, 168, 115, 109, 97, 108, 108, ... ]
// comparison with JSON
const json = JSON.stringify(obj);
const ratio = bytes.length / json.length;
console.log(msgpack: ${bytes.length}, json: ${json.length}, ratio: ${ratio.toFixed(2)});
// msgpack: 114, json: 178, ratio: 0.64
// roundtrip
const obj2 = deserialize(bytes);
// check equality
console.log(equiv(obj, obj2));
// true
`
If this project contributes to an academic publication, please cite it as:
`bibtex``
@misc{thing-msgpack,
title = "@thi.ng/msgpack",
author = "Karsten Schmidt",
note = "https://thi.ng/msgpack",
year = 2023
}
© 2023 - 2026 Karsten Schmidt // Apache License 2.0