TypeScript: Библиотека tslib
- вторник, 5 декабря 2017 г. в 03:14:37
Перевод. Оригинал по ссылке.
В некоторых случаях компилятор TypeScript
вставляет вспомогательные функции в сгенерированный JavaScript
код, которые потом вызываются во время исполнения. Каждая такая вспомогательная функция эмулирует семантику особенности языка, которая ещё не поддерживается браузерами нативно.
В настоящее время в TypeScript
существуют следующие вспомогательные функции:
__extends
для наследования__assign
для spread
оператора__rest
для rest
оператора__decorate
, __param
и __metadata
для декораторов__awaiter
и __generator
для async/await
Например, если следующий код:
import * as React from "react";
export default class FooComponent extends React.Component<{}, {}> {
render() {
return (
<div>Foo</div>
);
}
}
скомпилировать в стандарт ES5
, который не поддерживает ни класс, ни расширения, то на выходе получится:
"use strict";
var __extends = (this && this.__extends) || function (d, b) {
for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p];
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
var React = require("react");
var FooComponent = (function (_super) {
__extends(FooComponent, _super);
function FooComponent() {
return _super.apply(this, arguments) || this;
}
FooComponent.prototype.render = function () {
return (React.createElement("div", null, "Foo"));
};
return FooComponent;
}(React.Component));
Object.defineProperty(exports, "__esModule", { value: true });
exports.default = FooComponent;
Это подходит только для простых примеров, подобных тому, что описан выше. На деле же он имеет огромный недостаток.
Вспомогательная функция __extends
вставляется в скомпилированный результат для каждого файла, в котором вы используете наследование класса. Это значит, что для каждого компонента React
на основе класса вставляется функция-хелпер.
Для средних размеров приложения, включающего в себя десятки или сотни React
компонентов, это выльется в большое количество повторяющегося кода только для функции __extends
. Это увеличивает размер бандла, вследствие чего растёт время загрузки файла.
Эта проблема только усиливается, когда в скомпилированном результате используются другие хелперы. Вспомогательные функции __awaiter
и __generator
огромны, и делают существенный вклад в размер бандла. Запомните, они вставляются для каждого файла, в котором вы используете async/await
.
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
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) : new P(function (resolve) { resolve(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;
return { next: verb(0), "throw": verb(1), "return": verb(2) };
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 = y[op[0] & 2 ? "return" : op[0] ? "throw" : "next"]) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [0, 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 };
}
};
--noEmitHelpers
Начиная с версии 1.5
, TypeScript
поддерживает флаг --noEmitHelpers
. Если компилятор видит этот флаг, то TypeScript
не будет вставлять вспомогательные функции в скомпилированном коде.
React
компонент, описанный выше, скомпилированный с флагом --noEmitHelpers
:
"use strict";
var React = require("react");
var FooComponent = (function (_super) {
__extends(FooComponent, _super);
function FooComponent() {
return _super.apply(this, arguments) || this;
}
FooComponent.prototype.render = function () {
return (React.createElement("div", null, "Foo"));
};
return FooComponent;
}(React.Component));
Object.defineProperty(exports, "__esModule", { value: true });
exports.default = FooComponent;
Обратите внимание, что функция __extends
всё ещё вызывается. В конце концов, главное, чтобы компонент React
работал. Если вы используете флаг --noEmitHelpers
, то ваша обязанность предоставить все необходимые функции-хелперы. TypeScript
предполагает, что они будут доступны во время исполнения.
Однако, слишком трудозатратно делать это вручную. Вы должны проверить какие вспомогательные функции нужны и затем каким-то образом сделать их доступными в приложении. Перспектива совсем не радужная! К счастью, команда TypeScript
разработала решение.
--importHelpers
и библиотека tslib
В версии 2.1
появился новый флаг --importHelpers
, который говорит компилятору импортировать функции из внешней библиотеки помощников tslib
, а не встривать их для каждого файла. Вы можете установить и tslib
так же, как и любой другой пакет npm:
npm install tslib --save
Давайте перекомпилируем наш React
компонент. На этот раз с использованием флага --importHelpers
:
"use strict";
var tslib_1 = require("tslib");
var React = require("react");
var FooComponent = (function (_super) {
tslib_1.__extends(FooComponent, _super);
function FooComponent() {
return _super.apply(this, arguments) || this;
}
FooComponent.prototype.render = function () {
return (React.createElement("div", null, "Foo"));
};
return FooComponent;
}(React.Component));
Object.defineProperty(exports, "__esModule", { value: true });
exports.default = FooComponent;
Обратите внимание на require("tslib")
на второй строчке и использвание tslib_1.__extends
на пятой. В этом файле больше нет вспомогательной функции. Вместо этого функция __extends
импортируется из модуля tslib
. Таким образом, каждый хелпер импортируется только один раз, и вы не будете наказаны за использование extends
и async/await
во многих файлах.