https://github.com/yanhaijing/tslib
https://github.com/yanhaijing/tslib
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/yanhaijing/tslib
- Owner: yanhaijing
- License: mit
- Created: 2023-09-19T15:59:41.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-06T14:59:43.000Z (5 months ago)
- Last Synced: 2025-02-05T14:09:43.012Z (4 months ago)
- Language: JavaScript
- Size: 470 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# [tslib](https://github.com/yanhaijing/tslib)
[](https://github.com/yanhaijing/jslib-base)
[](https://github.com/yanhaijing/tslib/blob/master/LICENSE)
[](https://github.com/yanhaijing/tslib/actions/workflows/ci.yml)
[](https://www.npmjs.com/package/@js-lib/tslib)
[](http://www.npmtrends.com/@js-lib/tslib)
[](http://isitmaintained.com/project/yanhaijing/tslib "Percentage of issues still open")
The best third party `JS|TS` library scaffold.
## Characteristics
- Coded in ES6+ or TypeScript, easily compile and generate production code
- Supports multi environment, including default browsers, Node, AMD, CMD, Webpack, Rollup, Fis and so on.
- Integrated [jsmini](https://github.com/jsmini)
**Note:** When `export` and `export default` are not used at the same time, there is the option to
turn on `legacy mode`. Under `legacy mode`, the module system can be compatible with `IE6-8`. For more information on legacy mode,
please see rollup supplemental file.
## Compatibility
Unit tests guarantee support on the following environment:
| IE | CH | FF | SF | OP | IOS | Android | Node |
| ---- | ---- | ---- | ---- | ---- | ---- | ---- | ----- |
| 11+ | 100+ | 100+ | 16+ | 100+ | 10.3+ | 4.1+ | 14+ |
> Note: Compiling code depend on ES5, so you need import [es5-shim](http://github.com/es-shims/es5-shim/) to compatible with `IE6-8`, here is a [demo](./demo/demo-global.html)
## Directory
```
├── demo - Using demo
├── dist - Compiler output code
├── doc - Project documents
├── src - Source code directory
├── test - Unit tests
├── CHANGELOG.md - Change log
└── TODO.md - Planned features
```
## Usage Instructions
Using npm, download and install the code.
```bash
$ npm install --save @js-lib/tslib
```
For node environment：
```js
const tslib = require('@js-lib/tslib');
```
For webpack or similar environment：
```js
import tslib from '@js-lib/tslib';
```
For browser environment:
```html
```
## Documents
[API](./doc/api.md)
## Contribution Guide
For the first time to run, you need to install dependencies firstly.
```bash
$ npm install
```
To build the project:
```bash
$ npm run build
```
To run unit tests:
```bash
$ npm test
```
> Note: The browser environment needs to be tested manually under ```test/browser```
Modify the version number in package.json, modify the version number in README.md, modify the CHANGELOG.md, and then release the new version.
```bash
$ npm run release
```
Publish the new version to NPM.
```bash
$ npm publish
```
## Contributors
[contributors](https://github.com/yanhaijing/tslib/graphs/contributors)
## Change Log
[CHANGELOG.md](./CHANGELOG.md)
## TODO
[TODO.md](./TODO.md)