foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-25 15:29:32 -05:00
Code Issues Packages 1 Wiki Activity

ts_library_builder: update README (#2604)

Browse source
This commit is contained in:
Yoshiya Hinosawa 2019-06-30 23:52:28 +09:00 committed by Ryan Dahl
parent 5a4bebb770
commit 1068b4848c
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
tools/ts_library_builder/README.md
View file

@ -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