Strict function types

TypeScript 2.6 introduces a new strict checking flag, --strictFunctionTypes. The --strictFunctionTypes switch is part of the --strict family of switches, meaning that it defaults to on in --strict mode. You can opt-out by setting --strictFunctionTypes false on your command line or in your tsconfig.json.

Under --strictFunctionTypes function type parameter positions are checked contravariantly instead of bivariantly. For some background on what variance means for function types check out What are covariance and contravariance?.

The stricter checking applies to all function types, except those originating in method or constructor declarations. Methods are excluded specifically to ensure generic classes and interfaces (such as Array<T>) continue to mostly relate covariantly.

Consider the following example in which Animal is the supertype of Dog and Cat:

  1. ts
    declare let f1: (x: Animal) => void;
  2. declare let f2: (x: Dog) => void;
  3. declare let f3: (x: Cat) => void;
  4. f1 = f2; // Error with --strictFunctionTypes
  5. f2 = f1; // Ok
  6. f2 = f3; // Error

The first assignment is permitted in default type checking mode, but flagged as an error in strict function types mode. Intuitively, the default mode permits the assignment because it is possibly sound, whereas strict function types mode makes it an error because it isn’t provably sound. In either mode the third assignment is an error because it is never sound.

Another way to describe the example is that the type (x: T) => void is bivariant (i.e. covariant or contravariant) for T in default type checking mode, but contravariant for T in strict function types mode.

Example
  1. ts
    interface Comparer<T> {
  2.   compare: (a: T, b: T) => number;
  3. }
  5. declare let animalComparer: Comparer<Animal>;
  6. declare let dogComparer: Comparer<Dog>;
  8. animalComparer = dogComparer; // Error
  9. dogComparer = animalComparer; // Ok

The first assignment is now an error. Effectively, T is contravariant in Comparer<T> because it is used only in function type parameter positions.

By the way, note that whereas some languages (e.g. C# and Scala) require variance annotations (out/in or +/-), variance emerges naturally from the actual use of a type parameter within a generic type due to TypeScript’s structural type system.

Note

Under --strictFunctionTypes the first assignment is still permitted if compare was declared as a method. Effectively, T is bivariant in Comparer<T> because it is used only in method parameter positions.

  1. ts
    interface Comparer<T> {
  2.   compare(a: T, b: T): number;
  3. }
  5. declare let animalComparer: Comparer<Animal>;
  6. declare let dogComparer: Comparer<Dog>;
  8. animalComparer = dogComparer; // Ok because of bivariance
  9. dogComparer = animalComparer; // Ok

TypeScript 2.6 also improves type inference involving contravariant positions:

  1. ts
    function combine<T>(...funcs: ((x: T) => void)[]): (x: T) => void {
  2.   return x => {
  3.     for (const f of funcs) f(x);
  4.   };
  5. }
  7. function animalFunc(x: Animal) {}
  8. function dogFunc(x: Dog) {}
  10. let combined = combine(animalFunc, dogFunc); // (x: Dog) => void

Above, all inferences for T originate in contravariant positions, and we therefore infer the best common subtype for T. This contrasts with inferences from covariant positions, where we infer the best common supertype.

Cache tagged template objects in modules

TypeScript 2.6 fixes the tagged string template emit to align better with the ECMAScript spec. As per the ECMAScript spec, every time a template tag is evaluated, the same template strings object (the same TemplateStringsArray) should be passed as the first argument. Before TypeScript 2.6, the generated output was a completely new template object each time. Though the string contents are the same, this emit affects libraries that use the identity of the string for cache invalidation purposes, e.g. lit-html.

Example
  1. ts
    export function id(x: TemplateStringsArray) {
  2.   return x;
  3. }
  5. export function templateObjectFactory() {
  6.   return id`hello world`;
  7. }
  9. let result = templateObjectFactory() === templateObjectFactory(); // true in TS 2.6

Results in the following generated code:

  1. js
    "use strict";
  2. var __makeTemplateObject =
  3.   (this && this.__makeTemplateObject) ||
  4.   function(cooked, raw) {
  5.     if (Object.defineProperty) {
  6.       Object.defineProperty(cooked, "raw", { value: raw });
  7.     } else {
  8.       cooked.raw = raw;
  9.     }
  10.     return cooked;
  11.   };
  13. function id(x) {
  14.   return x;
  15. }
  17. var _a;
  18. function templateObjectFactory() {
  19.   return id(
  20.     _a || (_a = __makeTemplateObject(["hello world"], ["hello world"]))
  21.   );
  22. }
  24. var result = templateObjectFactory() === templateObjectFactory();

Note: This change brings a new emit helper, __makeTemplateObject; if you are using --importHelpers with tslib, an updated to version 1.8 or later.

Localized diagnostics on the command line

TypeScript 2.6 npm package ships with localized versions of diagnostic messages for 13 languages. The localized messages are available when using --locale flag on the command line.

Example

Error messages in Russian:

  1. sh
    c:\ts>tsc --v
  2. Version 2.6.0-dev.20171003
  4. c:\ts>tsc --locale ru --pretty c:\test\a.ts
  6. ../test/a.ts(1,5): error TS2322: Тип ""string"" не может быть назначен для типа "number".
  8. 1 var x: number = "string";
  9.       ~

And help in Japanese:

  1. sh
    PS C:\ts> tsc --v
  2. Version 2.6.0-dev.20171003
  4. PS C:\ts> tsc --locale ja-jp
  5. バージョン 2.6.0-dev.20171003
  6. 構文: tsc [オプション] [ファイル ...]
  8. 例:  tsc hello.ts
  9.     tsc --outFile file.js file.ts
  10.     tsc @args.txt
  12. オプション:
  13.  -h, --help                                 このメッセージを表示します。
  14.  --all                                      コンパイラ オプションをすべて表示します。
  15.  -v, --version                              コンパイラのバージョンを表示します。
  16.  --init                                     TypeScript プロジェクトを初期化して、tsconfig.json ファイルを作成します。
  17.  -p ファイルまたはディレクトリ, --project ファイルまたはディレクトリ  構成ファイルか、'tsconfig.json' を含むフォルダーにパスが指定されたプロジェクトをコ
  18. ンパイルします。
  19.  --pretty                                   色とコンテキストを使用してエラーとメッセージにスタイルを適用します (試験的)。
  20.  -w, --watch                                入力ファイルを監視します。
  21.  -t バージョン, --target バージョン                   ECMAScript のターゲット バージョンを指定します: 'ES3' (既定)、'ES5'、'ES2015'、'ES2016'、'ES2017'、'ES
  22. NEXT'。
  23.  -m 種類, --module 種類                         モジュール コード生成を指定します: 'none'、'commonjs'、'amd'、'system'、'umd'、'es2015'、'ESNext'。
  24.  --lib                                      コンパイルに含めるライブラリ ファイルを指定します:
  25.                                               'es5' 'es6' 'es2015' 'es7' 'es2016' 'es2017' 'esnext' 'dom' 'dom.iterable' 'webworker' 'scripthost' 'es201
  26. 5.core' 'es2015.collection' 'es2015.generator' 'es2015.iterable' 'es2015.promise' 'es2015.proxy' 'es2015.reflect' 'es2015.symbol' 'es2015.symbol.wellkno
  27. wn' 'es2016.array.include' 'es2017.object' 'es2017.sharedmemory' 'es2017.string' 'es2017.intl' 'esnext.asynciterable'
  28.  --allowJs                                  javascript ファイルのコンパイルを許可します。
  29.  --jsx 種類                                   JSX コード生成を指定します: 'preserve'、'react-native'、'react'。
  30.  -d, --declaration                          対応する '.d.ts' ファイルを生成します。
  31.  --sourceMap                                対応する '.map' ファイルを生成します。
  32.  --outFile ファイル                             出力を連結して 1 つのファイルを生成します。
  33.  --outDir ディレクトリ                            ディレクトリへ出力構造をリダイレクトします。
  34.  --removeComments                           コメントを出力しないでください。
  35.  --noEmit                                   出力しないでください。
  36.  --strict                                   strict 型チェックのオプションをすべて有効にします。
  37.  --noImplicitAny                            暗黙的な 'any' 型を含む式と宣言に関するエラーを発生させます。
  38.  --strictNullChecks                         厳格な null チェックを有効にします。
  39.  --noImplicitThis                           暗黙的な 'any' 型を持つ 'this' 式でエラーが発生します。
  40.  --alwaysStrict                             厳格モードで解析してソース ファイルごとに "use strict" を生成します。
  41.  --noUnusedLocals                           使用されていないローカルに関するエラーを報告します。
  42.  --noUnusedParameters                       使用されていないパラメーターに関するエラーを報告します。
  43.  --noImplicitReturns                        関数の一部のコード パスが値を返さない場合にエラーを報告します。
  44.  --noFallthroughCasesInSwitch               switch ステートメントに case のフォールスルーがある場合にエラーを報告します。
  45.  --types                                    コンパイルに含む型宣言ファイル。
  46.  @<ファイル>

Suppress errors in .ts files using ’// @ts-ignore’ comments

TypeScript 2.6 support suppressing errors in .js files using // @ts-ignore comments placed above the offending lines.

Example
  1. ts
    if (false) {
  2.   // @ts-ignore: Unreachable code error
  3.   console.log("hello");
  4. }

A // @ts-ignore comment suppresses all errors that originate on the following line. It is recommended practice to have the remainder of the comment following @ts-ignore explain which error is being suppressed.

Please note that this comment only suppresses the error reporting, and we recommend you use this comments very sparingly.

Faster tsc —watch

TypeScript 2.6 brings a faster --watch implementation. The new version optimizes code generation and checking for code bases using ES modules. Changes detected in a module file will result in only regenerating the changed module, and files that depend on it, instead of the whole project. Projects with large number of files should reap the most benefit from this change.

The new implementation also brings performance enhancements to watching in tsserver. The watcher logic has been completely rewritten to respond faster to change events.

Write-only references now flagged as unused

TypeScript 2.6 adds revised implementation the --noUnusedLocals and --noUnusedParameters compiler options. Declarations are only written to but never read from are now flagged as unused.

Example

Bellow both n and m will be marked as unused, because their values are never read. Previously TypeScript would only check whether their values were referenced.

  1. ts
    function f(n: number) {
  2.   n = 0;
  3. }
  5. class C {
  6.   private m: number;
  7.   constructor() {
  8.     this.m = 0;
  9.   }
  10. }

Also functions that are only called within their own bodies are considered unused.

Example
  1. ts
    function f() {
  2.   f(); // Error: 'f' is declared but its value is never read
  3. }