Skip to content
This repository has been archived by the owner on Oct 12, 2022. It is now read-only.

Create Keywords.md #344

Closed
wants to merge 51 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
31fff55
Add link to templates directory
mhegazy Jul 8, 2016
e8bcd2e
Make link to templates absolute
mhegazy Jul 8, 2016
98e1033
fixes typos
Jul 11, 2016
1e4bb08
fixes typo
Jul 11, 2016
df1296a
Merge pull request #338 from blacknight811/master
mhegazy Jul 11, 2016
bda7975
Fixed code typo in Modules.md
nippur72 Jul 13, 2016
5900976
Merge pull request #340 from nippur72/patch-1
mhegazy Jul 14, 2016
b628e33
Create Keywords.md
zspitz Jul 17, 2016
bee295f
Update Keywords.md
zspitz Jul 17, 2016
e111598
Update Keywords.md
zspitz Jul 17, 2016
f258174
lowercase type names, relative URLs
zspitz Jul 17, 2016
e3aaf09
Update Keywords.md
zspitz Jul 17, 2016
3c23ce8
Alphabetical order, and single list
zspitz Jul 18, 2016
3110858
Fixed broken lowercase links to Handbook
zspitz Jul 18, 2016
e11fa2f
Update Keywords.md
zspitz Jul 18, 2016
67e33c8
Added code formatting to keywords
zspitz Jul 18, 2016
ab67fa5
Added polymorphic `this` types and `this` function parameters
zspitz Jul 19, 2016
102a30f
Update Keywords.md
zspitz Jul 19, 2016
0bb4aeb
Added link - user-defined type guards
zspitz Jul 19, 2016
3fa50b8
Update Keywords.md
zspitz Jul 19, 2016
d87c35e
Fixed space in link line 53
zspitz Jul 19, 2016
eb2b912
Update Keywords.md
zspitz Jul 19, 2016
9f05002
Merge pull request #1 from Microsoft/release-2.0
zspitz Jul 19, 2016
10ddd2d
Link test
zspitz Jul 19, 2016
cbbd49f
Added category view
zspitz Jul 19, 2016
d17b9cf
Category link test
zspitz Jul 19, 2016
3bc3d30
Added links to category view
zspitz Jul 19, 2016
6e4906e
Fix double-blank line
zspitz Jul 19, 2016
345a6b1
Added `export` for namespaces
zspitz Jul 19, 2016
35a0bc1
Added `new` and `typeof` type annotation
zspitz Jul 20, 2016
1e4b6e5
Fix for test
zspitz Jul 20, 2016
12788c7
Add instructions on how to read the handbook.
jish Jul 21, 2016
632d8aa
Adhere to one sentence per line style guide.
jish Jul 21, 2016
35171f8
Merge pull request #351 from jish/where-to-read
DanielRosenwasser Jul 21, 2016
4826c50
Update README.md
DanielRosenwasser Jul 21, 2016
d654783
Remove uses of `null` as default value for flags
mhegazy Jul 24, 2016
6e834cd
Make default more explicit.
DanielRosenwasser Jul 25, 2016
8550e42
Separate external links column; property descriptor keywords
zspitz Aug 1, 2016
58a74c9
Reordered property descriptor keywords
zspitz Aug 1, 2016
6f7766c
Reordered category column after description
zspitz Aug 1, 2016
8eae732
Fixed empty links; categroixed yield with functions
zspitz Aug 1, 2016
eb5f8b4
Fixed configurable description
zspitz Aug 1, 2016
b2ef743
Fixed constructor link
zspitz Aug 1, 2016
6d4c103
Moved some spec links to external links column
zspitz Aug 4, 2016
7d50922
Merge pull request #2 from Microsoft/master
zspitz Aug 4, 2016
70f41dd
Fixed this-parameter link to Handbook
zspitz Aug 4, 2016
1241695
Fixed polymorphic this-type link
zspitz Aug 4, 2016
6d06909
Merge remote-tracking branch 'refs/remotes/origin/master'
zspitz Aug 4, 2016
99ab9ee
Added Syntax column
zspitz Aug 11, 2016
3bab206
Predefined type -> primitive type
zspitz Sep 7, 2016
8b54c8d
Pluralize primitive types
zspitz Sep 7, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Build Status](https://travis-ci.org/Microsoft/TypeScript-Handbook.svg)](https://travis-ci.org/Microsoft/TypeScript-Handbook)

The TypeScript Handbook is a comprehensive guide to the TypeScript language
The TypeScript Handbook is a comprehensive guide to the TypeScript language.
It is meant to be read online at [the TypeScript website](https://www.typescriptlang.org/docs/handbook/basic-types.html) or [directly from this repository](./pages/Basic Types.md).

Please see the [latest TypeScript Language Specification](https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md) for more details.
For a more formal description of the language, see the [latest TypeScript Language Specification](https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md).
20 changes: 10 additions & 10 deletions pages/Compiler Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
Option | Type | Default | Description
-----------------------------------------------|-----------|--------------------------------|----------------------------------------------------------------------
`--allowJs` | `boolean` | `true` | Allow JavaScript files to be compiled.
`--allowSyntheticDefaultImports` | `boolean` | `(module === "system")` | Allow default imports from modules with no default export. This does not affect code emit, just typechecking.
`--allowSyntheticDefaultImports` | `boolean` | `module === "system"` | Allow default imports from modules with no default export. This does not affect code emit, just typechecking.
`--allowUnreachableCode` | `boolean` | `false` | Do not report errors on unreachable code.
`--allowUnusedLabels` | `boolean` | `false` | Do not report errors on unused labels.
`--baseUrl` | `string` | | Base directory to resolve non-relative module names. See [Module Resolution documentation](./Module Resolution.md#base-url) for more details.
`--charset` | `string` | `"utf8"` | The character set of the input files.
`--declaration`<br/>`-d` | `boolean` | `false` | Generates corresponding '.d.ts' file.
`--declarationDir` | `string` | `null` | Output directory for generated declaration files.
`--declarationDir` | `string` | | Output directory for generated declaration files.
`--diagnostics` | `boolean` | `false` | Show diagnostic information.
`--disableSizeLimit` | `boolean` | `false` | Disable size limitation on JavaScript project.
`--emitBOM` | `boolean` | `false` | Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.
Expand All @@ -26,9 +26,9 @@ Option | Type | Default
`--listEmittedFiles` | `boolean` | `false` | Print names of generated files part of the compilation.
`--listFiles` | `boolean` | `false` | Print names of files part of the compilation.
`--locale` | `string` | *(platform specific)* | The locale to use to show error messages, e.g. en-us.
`--mapRoot` | `string` | `null` | Specifies the location where debugger should locate map files instead of generated locations. Use this flag if the .map files will be located at run-time in a different location than than the .js files. The location specified will be embedded in the sourceMap to direct the debugger where the map files where be located.
`--module`<br/>`-m` | `string` | `(target === 'ES6' ? 'ES6' : 'commonjs')` | Specify module code generation: `'none'`, `'commonjs'`, `'amd'`, `'system'`, `'umd'`, `'es6'`, or `'es2015'`.<br/>► Only `'amd'` and `'system'` can be used in conjunction with `--outFile`.<br/>► `'es6'` and `'es2015'` values may not be used when targeting ES5 or lower.
`--moduleResolution` | `string` | `(module === 'amd' | 'system' | 'ES6' ? 'classic' : 'node')` | Determine how modules get resolved. Either `'node'` for Node.js/io.js style resolution, or `'classic'` (default). See [Module Resolution documentation](Module Resolution.md) for more details.
`--mapRoot` | `string` | | Specifies the location where debugger should locate map files instead of generated locations. Use this flag if the .map files will be located at run-time in a different location than the .js files. The location specified will be embedded in the sourceMap to direct the debugger where the map files will be located.
`--module`<br/>`-m` | `string` | `target === 'ES6' ? 'ES6' : 'commonjs'` | Specify module code generation: `'none'`, `'commonjs'`, `'amd'`, `'system'`, `'umd'`, `'es6'`, or `'es2015'`.<br/>► Only `'amd'` and `'system'` can be used in conjunction with `--outFile`.<br/>► `'es6'` and `'es2015'` values may not be used when targeting ES5 or lower.
`--moduleResolution` | `string` | `module === 'amd' | 'system' | 'ES6' ? 'classic' : 'node'` | Determine how modules get resolved. Either `'node'` for Node.js/io.js style resolution, or `'classic'`. See [Module Resolution documentation](./Module Resolution.md) for more details.
`--newLine` | `string` | *(platform specific)* | Use the specified end of line sequence to be used when emitting files: `'crlf'` (windows) or `'lf'` (unix)."
`--noEmit` | `boolean` | `false` | Do not emit outputs.
`--noEmitHelpers` | `boolean` | `false` | Do not generate custom helper functions like `__extends` in compiled output.
Expand All @@ -42,21 +42,21 @@ Option | Type | Default
`--noResolve` | `boolean` | `false` | Do not add triple-slash references or module import targets to the list of compiled files.
`--noUnusedLocals` | `boolean` | `false` | Report errors on unused locals.
`--noUnusedParameters` | `boolean` | `false` | Report errors on unused parameters.
~~`--out`~~ | `string` | `null` | DEPRECATED. Use `--outFile` instead.
`--outDir` | `string` | `null` | Redirect output structure to the directory.
`--outFile` | `string` | `null` | Concatenate and emit output to single file. The order of concatenation is determined by the list of files passed to the compiler on the command line along with triple-slash references and imports. See output file order documentation for more details.
~~`--out`~~ | `string` | | DEPRECATED. Use `--outFile` instead.
`--outDir` | `string` | | Redirect output structure to the directory.
`--outFile` | `string` | | Concatenate and emit output to single file. The order of concatenation is determined by the list of files passed to the compiler on the command line along with triple-slash references and imports. See output file order documentation for more details.
`paths`<sup>[2]</sup> | `Object` | | List of path mapping entries for module names to locations relative to the `baseUrl`. See [Module Resolution documentation](./Module Resolution.md#path-mapping) for more details.
`--preserveConstEnums` | `boolean` | `false` | Do not erase const enum declarations in generated code. See [const enums documentation](https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md#94-constant-enum-declarations) for more details.
`--pretty`<sup>[1]</sup> | `boolean` | `false` | Stylize errors and messages using color and context.
`--project`<br/>`-p` | `string` | `null` | Compile a project given a valid configuration file.<br/>The argument can be an file path to a valid JSON configuration file, or a directory path to a directory containing a `tsconfig.json` file.<br/>See [tsconfig.json](./tsconfig.json.md) documentation for more details.
`--project`<br/>`-p` | `string` | | Compile a project given a valid configuration file.<br/>The argument can be an file path to a valid JSON configuration file, or a directory path to a directory containing a `tsconfig.json` file.<br/>See [tsconfig.json](./tsconfig.json.md) documentation for more details.
`--reactNamespace` | `string` | `"React"` | Specifies the object invoked for `createElement` and `__spread` when targeting 'react' JSX emit.
`--removeComments` | `boolean` | `false` | Remove all comments except copy-right header comments beginning with `/*!`
`--rootDir` | `string` | *(common root directory is computed from the list of input files)* | Specifies the root directory of input files. Only use to control the output directory structure with `--outDir`.
`rootDirs`<sup>[2]</sup> | `string[]`| | List of <i>root</i> folders whose combined content represent the structure of the project at runtime. See [Module Resolution documentation](./Module Resolution.md#virtual-directories-with-rootdirs) for more details.
`--skipLibCheck` | `boolean` | `false` | Don't check a the default library (`lib.d.ts`) file's valitidy.
`--skipDefaultLibCheck` | `boolean` | `false` | Don't check a user-defined default library (`*.d.ts`) file's valitidy.
`--sourceMap` | `boolean` | `false` | Generates corresponding '.map' file.
`--sourceRoot` | `string` | `null` | Specifies the location where debugger should locate TypeScript files instead of source locations. Use this flag if the sources will be located at run-time in a different location than that at design-time. The location specified will be embedded in the sourceMap to direct the debugger where the source files where be located.
`--sourceRoot` | `string` | | Specifies the location where debugger should locate TypeScript files instead of source locations. Use this flag if the sources will be located at run-time in a different location than that at design-time. The location specified will be embedded in the sourceMap to direct the debugger where the source files will be located.
`--strictNullChecks` | `boolean` | `false` | In strict null checking mode, the `null` and `undefined` values are not in the domain of every type and are only assignable to themselves and `any` (the one exception being that `undefined` is also assignable to `void`).
`--stripInternal`<sup>[1]</sup> | `boolean` | `false` | Do not emit declarations for code that has an `/** @internal */` JSDoc annotation.
`--suppressExcessPropertyErrors` | `boolean` | `false` | Suppress excess property checks for object literals.
Expand Down