Skip to content

Commit 62208ac

Browse files
committed
s/EncodeOptions/EncoderOptions/ and s/DecodeOptions/DecoderOptions/ in README
1 parent fdae5a3 commit 62208ac

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

README.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ deepStrictEqual(decode(encoded), object);
3838
- [Table of Contents](#table-of-contents)
3939
- [Install](#install)
4040
- [API](#api)
41-
- [`encode(data: unknown, options?: EncodeOptions): Uint8Array`](#encodedata-unknown-options-encodeoptions-uint8array)
42-
- [`EncodeOptions`](#encodeoptions)
43-
- [`decode(buffer: ArrayLike<number> | BufferSource, options?: DecodeOptions): unknown`](#decodebuffer-arraylikenumber--buffersource-options-decodeoptions-unknown)
44-
- [`DecodeOptions`](#decodeoptions)
45-
- [`decodeMulti(buffer: ArrayLike<number> | BufferSource, options?: DecodeOptions): Generator<unknown, void, unknown>`](#decodemultibuffer-arraylikenumber--buffersource-options-decodeoptions-generatorunknown-void-unknown)
46-
- [`decodeAsync(stream: ReadableStreamLike<ArrayLike<number> | BufferSource>, options?: DecodeAsyncOptions): Promise<unknown>`](#decodeasyncstream-readablestreamlikearraylikenumber--buffersource-options-decodeasyncoptions-promiseunknown)
47-
- [`decodeArrayStream(stream: ReadableStreamLike<ArrayLike<number> | BufferSource>, options?: DecodeAsyncOptions): AsyncIterable<unknown>`](#decodearraystreamstream-readablestreamlikearraylikenumber--buffersource-options-decodeasyncoptions-asynciterableunknown)
48-
- [`decodeMultiStream(stream: ReadableStreamLike<ArrayLike<number> | BufferSource>, options?: DecodeAsyncOptions): AsyncIterable<unknown>`](#decodemultistreamstream-readablestreamlikearraylikenumber--buffersource-options-decodeasyncoptions-asynciterableunknown)
41+
- [`encode(data: unknown, options?: EncoderOptions): Uint8Array`](#encodedata-unknown-options-encoderoptions-uint8array)
42+
- [`EncoderOptions`](#encoderoptions)
43+
- [`decode(buffer: ArrayLike<number> | BufferSource, options?: DecoderOptions): unknown`](#decodebuffer-arraylikenumber--buffersource-options-decoderoptions-unknown)
44+
- [`DecoderOptions`](#decoderoptions)
45+
- [`decodeMulti(buffer: ArrayLike<number> | BufferSource, options?: DecoderOptions): Generator<unknown, void, unknown>`](#decodemultibuffer-arraylikenumber--buffersource-options-decoderoptions-generatorunknown-void-unknown)
46+
- [`decodeAsync(stream: ReadableStreamLike<ArrayLike<number> | BufferSource>, options?: DecoderOptions): Promise<unknown>`](#decodeasyncstream-readablestreamlikearraylikenumber--buffersource-options-decoderoptions-promiseunknown)
47+
- [`decodeArrayStream(stream: ReadableStreamLike<ArrayLike<number> | BufferSource>, options?: DecoderOptions): AsyncIterable<unknown>`](#decodearraystreamstream-readablestreamlikearraylikenumber--buffersource-options-decoderoptions-asynciterableunknown)
48+
- [`decodeMultiStream(stream: ReadableStreamLike<ArrayLike<number> | BufferSource>, options?: DecoderOptions): AsyncIterable<unknown>`](#decodemultistreamstream-readablestreamlikearraylikenumber--buffersource-options-decoderoptions-asynciterableunknown)
4949
- [Reusing Encoder and Decoder instances](#reusing-encoder-and-decoder-instances)
5050
- [Extension Types](#extension-types)
5151
- [ExtensionCodec context](#extensioncodec-context)
@@ -80,7 +80,7 @@ npm install @msgpack/msgpack
8080

8181
## API
8282

83-
### `encode(data: unknown, options?: EncodeOptions): Uint8Array`
83+
### `encode(data: unknown, options?: EncoderOptions): Uint8Array`
8484

8585
It encodes `data` into a single MessagePack-encoded object, and returns a byte array as `Uint8Array`. It throws errors if `data` is, or includes, a non-serializable object such as a `function` or a `symbol`.
8686

@@ -105,7 +105,7 @@ const buffer: Buffer = Buffer.from(encoded.buffer, encoded.byteOffset, encoded.b
105105
console.log(buffer);
106106
```
107107

108-
#### `EncodeOptions`
108+
#### `EncoderOptions`
109109

110110
Name|Type|Default
111111
----|----|----
@@ -118,7 +118,7 @@ forceIntegerToFloat | boolean | false
118118
ignoreUndefined | boolean | false
119119
context | user-defined | -
120120

121-
### `decode(buffer: ArrayLike<number> | BufferSource, options?: DecodeOptions): unknown`
121+
### `decode(buffer: ArrayLike<number> | BufferSource, options?: DecoderOptions): unknown`
122122

123123
It decodes `buffer` that includes a MessagePack-encoded object, and returns the decoded object typed `unknown`.
124124

@@ -138,7 +138,7 @@ console.log(object);
138138

139139
NodeJS `Buffer` is also acceptable because it is a subclass of `Uint8Array`.
140140

141-
#### `DecodeOptions`
141+
#### `DecoderOptions`
142142

143143
Name|Type|Default
144144
----|----|----
@@ -152,7 +152,7 @@ context | user-defined | -
152152

153153
You can use `max${Type}Length` to limit the length of each type decoded.
154154

155-
### `decodeMulti(buffer: ArrayLike<number> | BufferSource, options?: DecodeOptions): Generator<unknown, void, unknown>`
155+
### `decodeMulti(buffer: ArrayLike<number> | BufferSource, options?: DecoderOptions): Generator<unknown, void, unknown>`
156156

157157
It decodes `buffer` that includes multiple MessagePack-encoded objects, and returns decoded objects as a generator. See also `decodeMultiStream()`, which is an asynchronous variant of this function.
158158

@@ -170,14 +170,12 @@ for (const object of decodeMulti(encoded)) {
170170
}
171171
```
172172

173-
### `decodeAsync(stream: ReadableStreamLike<ArrayLike<number> | BufferSource>, options?: DecodeAsyncOptions): Promise<unknown>`
173+
### `decodeAsync(stream: ReadableStreamLike<ArrayLike<number> | BufferSource>, options?: DecoderOptions): Promise<unknown>`
174174

175175
It decodes `stream`, where `ReadableStreamLike<T>` is defined as `ReadableStream<T> | AsyncIterable<T>`, in an async iterable of byte arrays, and returns decoded object as `unknown` type, wrapped in `Promise`.
176176

177177
This function works asynchronously, and might CPU resources more efficiently compared with synchronous `decode()`, because it doesn't wait for the completion of downloading.
178178

179-
`DecodeAsyncOptions` is the same as `DecodeOptions` for `decode()`.
180-
181179
This function is designed to work with whatwg `fetch()` like this:
182180

183181
```typescript
@@ -193,7 +191,7 @@ if (contentType && contentType.startsWith(MSGPACK_TYPE) && response.body != null
193191
} else { /* handle errors */ }
194192
```
195193

196-
### `decodeArrayStream(stream: ReadableStreamLike<ArrayLike<number> | BufferSource>, options?: DecodeAsyncOptions): AsyncIterable<unknown>`
194+
### `decodeArrayStream(stream: ReadableStreamLike<ArrayLike<number> | BufferSource>, options?: DecoderOptions): AsyncIterable<unknown>`
197195

198196
It is alike to `decodeAsync()`, but only accepts a `stream` that includes an array of items, and emits a decoded item one by one.
199197

@@ -210,7 +208,7 @@ for await (const item of decodeArrayStream(stream)) {
210208
}
211209
```
212210

213-
### `decodeMultiStream(stream: ReadableStreamLike<ArrayLike<number> | BufferSource>, options?: DecodeAsyncOptions): AsyncIterable<unknown>`
211+
### `decodeMultiStream(stream: ReadableStreamLike<ArrayLike<number> | BufferSource>, options?: DecoderOptions): AsyncIterable<unknown>`
214212

215213
It is alike to `decodeAsync()` and `decodeArrayStream()`, but the input `stream` must consist of multiple MessagePack-encoded items. This is an asynchronous variant for `decodeMulti()`.
216214

@@ -306,7 +304,7 @@ Not that extension types for custom objects must be `[0, 127]`, while `[-1, -128
306304

307305
#### ExtensionCodec context
308306

309-
When you use an extension codec, it might be necessary to have encoding/decoding state to keep track of which objects got encoded/re-created. To do this, pass a `context` to the `EncodeOptions` and `DecodeOptions`:
307+
When you use an extension codec, it might be necessary to have encoding/decoding state to keep track of which objects got encoded/re-created. To do this, pass a `context` to the `EncoderOptions` and `DecoderOptions`:
310308

311309
```typescript
312310
import { encode, decode, ExtensionCodec } from "@msgpack/msgpack";

0 commit comments

Comments
 (0)