跳至主要內容

指南

JowayYoung2025/5/15大约 4 分钟

背景

工欲善其事，必先利其器。在研发时，经常会遇到一些重复使用的工具函数。例如，Web类型、格式时间差、URL参数反序列化、过滤XSS等函数。这些工具函数在每个项目中都要使用，如果每次都是重复地复制粘贴，显然会浪费很多时间和精力。

为了解决这个问题，将常见的工具函数进行分类整理，再将它们封装为一个独立的模块，然后将这个模块发布到Npm公有仓库中，供其他开发人员使用。这样一来，每次在研发时，只需通过Npm安装这个工具函数模块，然后在代码引入。这样大大提高开发效率，也避免复制粘贴的操作带来的重复劳动和可能错误。

因为这些工具函数都是根据功能进行分类，所以在需要使用某个功能时，只需查找对应功能并读取其文档，就能快速掌握如何使用这个函数。这样可以将更多时间用在解决项目的实际问题中，而不是浪费在琐碎的代码复制粘贴中。同时，这也是笔者在工作中遵循的一条原则：工欲善其事，必先利其器。

介绍

bruce-us

@yangzw/bruce-us是一个没有框架约束的通用工具库，提供Web环境、Node环境和混合环境的工具函数。

它是一个非常实用的工具库，不依赖于任何框架，还具备出色的跨平台兼容性。它提供很多常见的工具函数，可以帮助开发人员更加高效地完成编码。无论你是前端开发还是后端开发，都能使用这个工具库简化开发过程。无论是在浏览器中还是在服务器中，都能使用这个工具库处理各种任务。无论你是需要处理字符串、数组、布尔还是进行DOM操作、URL操作，这个工具库都能满足你的需求。所以，如果你正在寻找一个没有框架约束的通用工具库，@yangzw/bruce-us绝对是一个不错的选择。

整体包括107个函数，分别是Common函数66个，Web函数27个，Node函数14个。

authorversionnodenpmtestbuildcoveragelicense

安装

使用npm/yarn/pnpm安装@yangzw/bruce-us。

npm
npm i @yangzw/bruce-us

如果需要使用Aios()，请安装axios且其版本必须大于等于1.5.0。

npm
npm i axios

如果需要使用Aios()且兼容低版本浏览器，请安装axios且其版本必须等于1.5.0。

npm
npm i axios@1.5.0

使用

@yangzw/bruce-us根据Web和Node两种JS运行时环境划分代码，生成三种bundle.js。每个文件在不同JS运行时环境中运行，必须根据JS运行时环境引用文件，否则会报错。

模块工具库运行环境对应文件ESM对应文件UMD对应文件
Common通用工具库浏览器
服务器		index.jsindex.esm.jsindex.umd.js
WebWeb工具库浏览器web.jsweb.esm.jsweb.umd.js
NodeNode工具库服务器node.jsnode.esm.js-

兼容

  • Web：>=95%
  • Node：>=95%

Common函数没有符号标记，Web函数使用🔥符号标记，Node函数使用💧符号标记。每个函数功能的右侧可能标记一个🔥/💧，如果没有标记，在混合环境中都能使用，具体操作请查看使用。

web.js/web.esm.js引用axios，如果引入它们且要兼容低版本浏览器，需要将axios纳入构建工具的编译范围。因为axios的打包文件包括ES6特性语法，如果在构建阶段不处理它，那么低版本浏览器就会报错。

使用webpack作为构建工具时，需要在babel-loader的include中处理。使用@yangzw/bruce-app作为构建工具时，需要在brucerc.(js|json|ts|yaml)的transpileDeps中处理。

import { defineConfig } from "@yangzw/bruce-type";

export default defineConfig({
	// ...
	transpileDeps: [
		"axios"
	] // 转译依赖：Array
});
最近更新：
贡献者: JowayYoung