TypeScript is a superset of JavaScript, therefore all JavaScript conventions and good practices also applies here. Exceptions or changes to these rules are noted in this file.
For TypeScript-specific rules, you can take cues from the TypeScript Deep Dive Style Guide, this is a great source for community-approved conventions.
- Use
PascalCasefor type names and enum values - Do not use
_as a prefix for private properties
- Do not export types/functions unless you need to share it across multiple components
- Do not introduce new types/values to the global namespace
- Use arrow functions over anonymous function expressions
- Only surround arrow function parameters when necessary.
For example,
(x) => x + xis wrong but the following are correct:x => x + x(x,y) => x + y<T>(x: T, y: T) => x === y
In order to infer types from JavaScript, the TypeScript language supports external type definitions. They are located
in the typings folder.
To automatically download or update typings for your bower dependencies, use the gulp tsd command. Note that removed
dependencies will not be removed automatically, you need to removed them manually. This is by design, so you can add
custom typings if needed in the typings folder.
If you want to further manage your types definitions, you can use the TSD tool.
As with JavaScript, coding rules are enforced in this project, via TSLint.
The read of TypeScript Deep Dive is recommended, this is the definitive reference book for TypeScript (and also open-source).