Navigation Menu

Skip to content

Commit

Permalink
ts_library_builder: update README (denoland#2604)
Browse files Browse the repository at this point in the history
  • Loading branch information
kt3k authored and ry committed Jun 30, 2019
1 parent 5a4bebb commit 1068b48
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions tools/ts_library_builder/README.md
Expand Up @@ -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
Expand Down

0 comments on commit 1068b48

Please sign in to comment.