GeezerVison is showing github.com — msgpack-javascript/src/encode.ts at main · msgpack/msgpack-javascript

Expand file tree

encode.ts

Copy path

More file actions

Latest commit

History

17 lines (16 loc) · 660 Bytes

encode.ts

Copy path

File metadata and controls

17 lines (16 loc) · 660 Bytes

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

import { Encoder } from "./Encoder.ts";

import type { EncoderOptions } from "./Encoder.ts";

import type { SplitUndefined } from "./context.ts";

/**

* It encodes `value` in the MessagePack format and

* returns a byte buffer.

* The returned buffer is a slice of a larger `ArrayBuffer`, so you have to use its `#byteOffset` and `#byteLength` in order to convert it to another typed arrays including NodeJS `Buffer`.

export function encode<ContextType = undefined>(

value: unknown,

options?: EncoderOptions<SplitUndefined<ContextType>>,

): Uint8Array<ArrayBuffer> {

const encoder = new Encoder(options);

return encoder.encodeSharedRef(value);

}