decodeJsonValue - API reference

API reference › @evolu/common › Buffer › decodeJsonValue

function decodeJsonValue(buffer: Buffer): JsonValue;

Defined in: packages/common/src/Buffer.ts:337

Decodes a JsonValue using the MessagePack format.

Throws a BufferError without modifying the Buffer if the encoded value is malformed, truncated, unsupported, outside the JsonValue domain, or exceeds 1,000 nested arrays or objects.

Example

import { assertEqual, createBuffer, decodeJsonValue } from "@evolu/common";

const buffer = createBuffer([
  0x81, 0xa4, 0x6e, 0x61, 0x6d, 0x65, 0xa3, 0x41, 0x64, 0x61,
]);

assertEqual(decodeJsonValue(buffer), { name: "Ada" });
assertEqual(buffer.unwrap(), new Uint8Array());