Skip to content

Commit e705925

Browse files
committed
1 parent 79819a2 commit e705925

File tree

2 files changed

+38
-3
lines changed

2 files changed

+38
-3
lines changed

.vscode/settings.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@
55
{ "language": "typescript", "autoFix": true },
66
{ "language": "typescriptreact", "autoFix": true }
77
],
8-
"typescript.tsdk": "node_modules/typescript/lib"
8+
"typescript.tsdk": "node_modules/typescript/lib",
9+
"files.eol": "\n"
910
}

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,40 @@ const encoded: Uint8Array = encode(object);
3232
deepStrictEqual(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

3771
This 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" });
5589
console.log(encoded);
5690
```
5791

58-
#### EncodeOptions
92+
#### `EncodeOptions`
5993

6094
Name|Type|Default
6195
----|----|----
@@ -80,7 +114,7 @@ const object = decode(encoded);
80114
console.log(object);
81115
```
82116

83-
#### DecodeOptions
117+
#### `DecodeOptions`
84118

85119
Name|Type|Default
86120
----|----|----

0 commit comments

Comments
 (0)