Runtime library for TypeScript helpers.
Перейти к файлу
Orta Therox faf63aec0c
Merge pull request #123 from alan-agius4/patch-1
docs: update readme to mention tslib and typescript versions
2020-09-23 11:40:34 -04:00
.github/workflows Remove unneeded dependency 2020-02-20 13:22:26 -08:00
docs Added generator documentation from #2 2016-09-13 14:10:40 -07:00
.gitattributes Added initial version of tslib.js 2015-04-22 13:47:06 -07:00
.gitignore General cleanup. 2016-05-18 13:25:21 -07:00
.npmignore build: exclude github workflows from npm package 2020-02-21 10:14:14 +01:00
CopyrightNotice.txt Don't be so reserved about a relicense. 2020-04-21 16:54:49 -07:00
LICENSE.txt Don't be so reserved about a relicense. 2020-04-21 16:54:49 -07:00
README.md Merge pull request #123 from alan-agius4/patch-1 2020-09-23 11:40:34 -04:00
bower.json manually update to 2.0.1 2020-08-06 15:30:27 -07:00
package.json manually update to 2.0.1 2020-08-06 15:30:27 -07:00
tslib.d.ts Rename exports argument in exportStar 2020-07-29 17:02:40 -07:00
tslib.es6.html Added html importable files 2016-11-13 21:18:11 +01:00
tslib.es6.js Rename exports argument in exportStar 2020-07-29 17:02:40 -07:00
tslib.html Added html importable files 2016-11-13 21:18:11 +01:00
tslib.js Rename exports argument in exportStar 2020-07-29 17:02:40 -07:00

README.md

tslib

This is a runtime library for TypeScript that contains all of the TypeScript helper functions.

This library is primarily used by the --importHelpers flag in TypeScript. When using --importHelpers, a module that uses helper functions like __extends and __assign in the following emitted file:

var __assign = (this && this.__assign) || Object.assign || function(t) {
    for (var s, i = 1, n = arguments.length; i < n; i++) {
        s = arguments[i];
        for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
            t[p] = s[p];
    }
    return t;
};
exports.x = {};
exports.y = __assign({}, exports.x);

will instead be emitted as something like the following:

var tslib_1 = require("tslib");
exports.x = {};
exports.y = tslib_1.__assign({}, exports.x);

Because this can avoid duplicate declarations of things like __extends, __assign, etc., this means delivering users smaller files on average, as well as less runtime overhead. For optimized bundles with TypeScript, you should absolutely consider using tslib and --importHelpers.

Installing

For the latest stable version, run:

npm

# TypeScript 3.9.2 or later
npm install --save tslib

# TypeScript 3.8.4 or earlier
npm install --save tslib@1.13.0

# TypeScript 2.3.2 or earlier
npm install --save tslib@1.6.1

yarn

# TypeScript 3.9.2 or later
yarn add tslib

# TypeScript 3.8.4 or earlier
yarn add tslib@1.13.0

# TypeScript 2.3.2 or earlier
yarn add tslib@1.6.1

bower

# TypeScript 3.9.2 or later
bower install tslib

# TypeScript 3.8.4 or earlier
bower install tslib@1.13.0

# TypeScript 2.3.2 or earlier
bower install tslib@1.6.1

JSPM

# TypeScript 3.9.2 or later
jspm install tslib

# TypeScript 3.8.4 or earlier
jspm install tslib@1.13.0

# TypeScript 2.3.2 or earlier
jspm install tslib@1.6.1

Usage

Set the importHelpers compiler option on the command line:

tsc --importHelpers file.ts

or in your tsconfig.json:

{
    "compilerOptions": {
        "importHelpers": true
    }
}

For bower and JSPM users

You will need to add a paths mapping for tslib, e.g. For Bower users:

{
    "compilerOptions": {
        "module": "amd",
        "importHelpers": true,
        "baseUrl": "./",
        "paths": {
            "tslib" : ["bower_components/tslib/tslib.d.ts"]
        }
    }
}

For JSPM users:

{
    "compilerOptions": {
        "module": "system",
        "importHelpers": true,
        "baseUrl": "./",
        "paths": {
            "tslib" : ["jspm_packages/npm/tslib@2.0.1/tslib.d.ts"]
        }
    }
}

Contribute

There are many ways to contribute to TypeScript.

Documentation