Skip to content

Commit 0290734

Browse files
committed
clarify TypeScript type definitions (regarding #193)
1 parent 9016424 commit 0290734

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ deepStrictEqual(decode(encoded), object);
6060
- [Prerequisites](#prerequisites)
6161
- [ECMA-262](#ecma-262)
6262
- [NodeJS](#nodejs)
63-
- [TypeScript](#typescript)
63+
- [TypeScript Compiler / Type Definitions](#typescript-compiler--type-definitions)
6464
- [Benchmark](#benchmark)
6565
- [Distribution](#distribution)
6666
- [NPM / npmjs.com](#npm--npmjscom)
@@ -504,11 +504,11 @@ NodeJS v10 is required, but NodeJS v12 or later is recommended because it includ
504504

505505
NodeJS before v10 will work by importing `@msgpack/msgpack/dist.es5+umd/msgpack`.
506506

507-
### TypeScript
507+
### TypeScript Compiler / Type Definitions
508508

509-
This module requires definitions of `AsyncIterator` and whatwg streams, which is specified with `"lib": ["ES2020", "DOM"]` in `tsconfig.json`.
509+
This module requires type definitions of `AsyncIterator`, `SourceBuffer`, whatwg streams, and so on. They are provided by `"lib": ["ES2021", "DOM"]` in `tsconfig.json`.
510510

511-
For the TypeScript version, the latest TypeScript is tested in development, but older versions of TypeScript might be able to compile this module.
511+
Regarding the TypeScript compiler version, only the latest TypeScript is tested in development.
512512

513513
## Benchmark
514514

0 commit comments

Comments
 (0)