-
Notifications
You must be signed in to change notification settings - Fork 150
/
encode.ts
27 lines (24 loc) · 841 Bytes
/
encode.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
import { Encoder } from "./Encoder";
import type { EncoderOptions } from "./Encoder";
import type { SplitUndefined } from "./context";
/**
* @deprecated Use {@link EncoderOptions} instead.
*/
export type EncodeOptions = never;
/**
* @deprecated No longer supported.
*/
export const defaultEncodeOptions: never = undefined as never;
/**
* 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 {
const encoder = new Encoder(options);
return encoder.encodeSharedRef(value);
}