$ ryokkkke.com/TypeScript/tsconfig.json

importHelpers

概要

https://www.typescriptlang.org/tsconfig#target

importHelpers

{
  "importHelpers": true
}

コンパイル結果に Polyfill が必要な場合、出力結果の JS 上でそれら定義するのではなくtslibからimportすることで、出力結果のファイルサイズを削減する。

$ npm install --save tslib

が必要。

詳細

例えば、下記のコードを、targetオプションなし(値はデフォルト値のES3になる)でコンパイルしてみます。

// index.ts

export const func = async () => {
  return new Promise<string>((resolve) => {
    setTimeout(() => {
      resolve("5秒経ちました");
    }, 5000);
  });
};

(ちなみにこの場合 ES3 にPromiseは存在しないので、libで指定する必要があります。)

{
  "lib": ["DOM", "ES2015"]
}

すると、結果は下記のように、ES3 に準拠した形でコードを再現するための Polyfill が上半分以上で定義されているのが分かります。

// index.js

"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
var __generator = (this && this.__generator) || function (thisArg, body) {
    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
    function verb(n) { return function (v) { return step([n, v]); }; }
    function step(op) {
        if (f) throw new TypeError("Generator is already executing.");
        while (_) try {
            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
            if (y = 0, t) op = [op[0] & 2, t.value];
            switch (op[0]) {
                case 0: case 1: t = op; break;
                case 4: _.label++; return { value: op[1], done: false };
                case 5: _.label++; y = op[1]; op = [0]; continue;
                case 7: op = _.ops.pop(); _.trys.pop(); continue;
                default:
                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
                    if (t[2]) _.ops.pop();
                    _.trys.pop(); continue;
            }
            op = body.call(thisArg, _);
        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
    }
};

// ここまでPolyfillの定義

exports.__esModule = true;
exports.func = void 0;
exports.func = function () { return __awaiter(void 0, void 0, void 0, function () {
    return __generator(this, function (_a) {
        return [2 /*return*/, new Promise(function (resolve) {
                setTimeout(function () {
                    resolve("5秒経ちました");
                }, 5000);
            })];
    });
}); };

これが 1 ファイルだけならまだ良いですが、複数のファイルで同じように Polyfill が必要な記法を使用すると、全てのファイルにこの定義のコードが生成されてしまいます。
Polyfill の内容はファイルごとに変わらないため、これを一つのファイルから参照するようにすれば、コード量を大幅に削減できます。

そこで、このオプションをtrueにしてコンパイルした結果が以下です。

// index.js

"use strict";
exports.__esModule = true;
exports.func = void 0;
var tslib_1 = require("tslib");
exports.func = function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
    return tslib_1.__generator(this, function (_a) {
        return [2 /*return*/, new Promise(function (resolve) {
                setTimeout(function () {
                    resolve("5秒経ちました");
                }, 5000);
            })];
    });
}); };

Polyfill の定義が消え、

var tslib_1 = require("tslib");

が追加されています。
つまり、ファイルごとに定義するのではなく、モジュールとして切り出してそれを参照するという形になりました。

もちろん、require するということはそのモジュールが必要なので、これを有効にする場合はtslibをインストールする必要があります。

$ npm install --save tslib

インストールしないでコンパイルすると、下記のようなエラーが出ます。

src/index.ts:1:21 - error TS2354: This syntax requires an imported helper but module 'tslib' cannot be found.