better-js-lib

最好用的 TS 函数库

Docs

:star: 特性

• 使用 typescript 编写，提供更好的代码提示和类型检查
• tree-shaking 支持
• 持续更新，欢迎 issue & RP ~

:pill: 兼容性

单元测试保证支持如下环境：

| IE | CH | FF | SF | OP | IOS | Android | Node | | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ----- | | 6+ | 29+ | 55+ | 9+ | 50+ | 9+ | 4+ | 10+ |

注意：编译代码依赖ES5环境，对于ie6-8需要引入es5-shim才可以兼容，可以查看demo/demo-global.html中的例子

:open_file_folder: 目录介绍

.
├── demo 使用demo
├── es 编译产出代码(esm)
├── lib 编译产出代码(cjs)
├── doc 项目文档
├── src 源代码目录
├── test 单元测试
├── CHANGELOG.md 变更日志
└── TODO.md 计划功能

:rocket: 使用者指南

通过npm下载安装代码

$ npm install --save better-js-lib

import utils from 'better-js-lib';
// 按需引入函数
import { is } from 'better-js-lib';

:bookmark_tabs: 文档

:kissing_heart: 贡献者指南

首次运行需要先安装依赖

$ npm install

一键打包生成生产代码

$ npm run build

运行单元测试:

$ npm test

注意：浏览器环境需要手动测试，位于test/browser

修改 package.json 中的版本号，修改 CHANGELOG.md，然后发布新版

$ npm run release

将新版本发布到npm

$ npm publish

贡献者列表

contributors

:gear: 更新日志

CHANGELOG.md

:airplane: 计划列表

TODO.md