diff options
| author | Yoshiya Hinosawa <stibium121@gmail.com> | 2019-06-30 23:52:28 +0900 |
|---|---|---|
| committer | Ryan Dahl <ry@tinyclouds.org> | 2019-06-30 10:52:28 -0400 |
| commit | 1068b4848c4d6d9a444d2d2bca5f25d822c42ff5 (patch) | |
| tree | eff365b7c9df7fe4b8b50bc790d45ebc165ea9fc | |
| parent | 5a4bebb77080d8a72a3faa594a388c6bce46e346 (diff) | |
ts_library_builder: update README (#2604)
| -rw-r--r-- | tools/ts_library_builder/README.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/tools/ts_library_builder/README.md b/tools/ts_library_builder/README.md index 187d753e6..c96fba16b 100644 --- a/tools/ts_library_builder/README.md +++ b/tools/ts_library_builder/README.md @@ -2,13 +2,13 @@ This tool allows us to produce a single TypeScript declaration file that describes the complete Deno runtime, including global variables and the built-in -`deno` module. The output of this tool, `lib.deno_runtime.d.ts`, serves several -purposes: +`Deno` global object. The output of this tool, `lib.deno_runtime.d.ts`, serves +several purposes: 1. It is passed to the TypeScript compiler `js/compiler.ts`, so that TypeScript knows what types to expect and can validate code against the runtime environment. -2. It is outputted to stdout by `deno --types`, so that users can easily have +2. It is outputted to stdout by `deno types`, so that users can easily have access to the complete declaration file. Editors can use this in the future to perform type checking. 3. Because JSDocs are maintained, this serves as a simple documentation page for |