Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 1.88 KB

README.ZH.md

File metadata and controls

54 lines (33 loc) · 1.88 KB

@wgbx/tools

业务库工具集

安装

npm install @wgbx/tools
// or
pnpm add @wgbx/tools

什么是 @wgbx/tools

@wgbx/tools,是一个短小而精悍的现代 JavaScript 使用工具库

动机

我们在开发业务中总是不得不使用一些方法来提高我们的效率,随着生态越来越完善,项目越来越多,我们存在业务方法在项目中重复使用的情况,导致代码冗余,维护成本增加

有一些基础的业务方法在项目中应该提供,避免在使用时紧急开发,但我们的方法经常并不会进行严格的单元测试,这也会导致一些 bug 产生

另外随着 ESM 规范被越来越多的现代浏览器所支持,我们迫切希望拥有一个轻量级,适合现代浏览器,能够像查字典一样根据具体的业务调用函数或工具

所以,我们发起了 @wgbx/tools,系统能够为前端开发者们提供基础且全面的业务工具库

特点

我们做了一些事情,让其更加先进。

通俗易懂的文档

基于最新 VitePress 构建,更快,更便捷 更快的热更新

更轻量级,更易扩展

使用 Rollup 打包 动态插件,你可以一分钟内挂载你喜欢的插件 按需加载使用

基于 TypeScript

适用于更多的场景 包含基础类库,删除冗余函数和废弃的 API 附带详细的注释 (func/desc/returns/example...)

单元测试

方法提供单元测试,保证函数稳定性

他和 lodash 有什么不同?

功能范围:lodash 是工具函数库,他并不会参与业务,@wgbx/tools 是一个业务类库,他可以参与业务,并且提供业务级别的工具 可定制型:lodash 提供了很多工具函数,但无法定制,@wgbx/tools 提供了很多工具函数,并且支持动态扩展,你可以根据你的需求添加你自己的工具函数