@@ -32,6 +32,40 @@ const encoded: Uint8Array = encode(object);
3232deepStrictEqual (decode (encoded ), object );
3333```
3434
35+ ## Table of Contents
36+
37+ <!-- TOC depthFrom:2 anchorMode:github.com -->
38+
39+ - [ Synopsis] ( #synopsis )
40+ - [ Table of Contents] ( #table-of-contents )
41+ - [ Install] ( #install )
42+ - [ API] ( #api )
43+ - [ ` encode(data: unknown, options?: EncodeOptions): Uint8Array ` ] ( #encodedata-unknown-options-encodeoptions-uint8array )
44+ - [ ` EncodeOptions ` ] ( #encodeoptions )
45+ - [ ` decode(buffer: ArrayLike<number>, options?: DecodeOptions): unknown ` ] ( #decodebuffer-arraylikenumber-options-decodeoptions-unknown )
46+ - [ ` DecodeOptions ` ] ( #decodeoptions )
47+ - [ ` decodeAsync(stream: AsyncIterable<ArrayLike<number>> | ReadableStream<ArrayLike<number>>, options?: DecodeAsyncOptions): Promise<unknown> ` ] ( #decodeasyncstream-asynciterablearraylikenumber--readablestreamarraylikenumber-options-decodeasyncoptions-promiseunknown )
48+ - [ ` decodeArrayStream(stream: AsyncIterable<ArrayLike<number>> | ReadableStream<ArrayLike<number>>, options?: DecodeAsyncOptions): AsyncIterable<unknown> ` ] ( #decodearraystreamstream-asynciterablearraylikenumber--readablestreamarraylikenumber-options-decodeasyncoptions-asynciterableunknown )
49+ - [ ` decodeStream(stream: AsyncIterable<ArrayLike<number>> | ReadableStream<ArrayLike<number>>, options?: DecodeAsyncOptions): AsyncIterable<unknown> ` ] ( #decodestreamstream-asynciterablearraylikenumber--readablestreamarraylikenumber-options-decodeasyncoptions-asynciterableunknown )
50+ - [ Extension Types] ( #extension-types )
51+ - [ Handling BigInt with ExtensionCodec] ( #handling-bigint-with-extensioncodec )
52+ - [ The temporal module as timestamp extensions] ( #the-temporal-module-as-timestamp-extensions )
53+ - [ MessagePack Specification] ( #messagepack-specification )
54+ - [ MessagePack Mapping Table] ( #messagepack-mapping-table )
55+ - [ Prerequsites] ( #prerequsites )
56+ - [ ECMA-262] ( #ecma-262 )
57+ - [ NodeJS] ( #nodejs )
58+ - [ Benchmark] ( #benchmark )
59+ - [ Distrubition] ( #distrubition )
60+ - [ Maintenance] ( #maintenance )
61+ - [ Testing] ( #testing )
62+ - [ Relase Engineering] ( #relase-engineering )
63+ - [ Updating Dependencies] ( #updating-dependencies )
64+ - [ Big Thanks] ( #big-thanks )
65+ - [ License] ( #license )
66+
67+ <!-- /TOC -->
68+
3569## Install
3670
3771This library is publised as [ @msgpack/msgpack ] ( https://www.npmjs.com/package/@msgpack/msgpack ) in npmjs.com.
@@ -55,7 +89,7 @@ const encoded: Uint8Array = encode({ foo: "bar" });
5589console .log (encoded );
5690```
5791
58- #### EncodeOptions
92+ #### ` EncodeOptions `
5993
6094Name|Type|Default
6195----|----|----
@@ -80,7 +114,7 @@ const object = decode(encoded);
80114console .log (object );
81115```
82116
83- #### DecodeOptions
117+ #### ` DecodeOptions `
84118
85119Name|Type|Default
86120----|----|----
0 commit comments