@bj-nsc/functions

nsc-functions

浏览器和工程项目共用的工具函数库。

安装

// 安装
npm install @bj-nsc/functions --save;
// 或者
yarn add @bj-nsc/functions;

工程项目使用

import { sm3Encrypt, guid, getStorage } from "@bj-nsc/functions";

console.log(sm3Encrypt("test"));
console.log(guid());
console.log(getStorage("token"));

Script 引入

执行 npm run build:browser 后会生成 dist/nsc-functions.min.js，可以直接通过 <script> 标签使用，默认挂载到全局变量 NscUtils。

<script src="https://unpkg.com/@bj-nsc/functions/dist/nsc-functions.min.js"></script>
<script>
  const { sm3Encrypt, guid, getStorage } = NscUtils;

  console.log(sm3Encrypt("test"));
  console.log(guid());
  console.log(getStorage("token"));
</script>

也可以使用 jsDelivr：

<script src="https://cdn.jsdelivr.net/npm/@bj-nsc/functions/dist/nsc-functions.min.js"></script>

如果需要固定版本，建议在 CDN 地址里显式带上版本号：

<script src="https://unpkg.com/@bj-nsc/functions@2.0.0/dist/nsc-functions.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@bj-nsc/functions@2.0.0/dist/nsc-functions.min.js"></script>

浏览器构建配置说明

浏览器包通过下面这条命令生成：

npm run build:browser

这条命令会先清理 dist 目录，再读取根目录的 esbuild.browser.config.cjs 进行构建。

• 构建配置文件：esbuild.browser.config.cjs
• 浏览器输出文件：dist/nsc-functions.min.js
• 浏览器全局变量：NscUtils
• 浏览器输出格式：iife

当前这份浏览器构建配置主要负责两件事：

• 把 src/index.ts 直接打成浏览器可通过 <script> 使用的单文件产物
• 用 NscUtils 作为浏览器全局入口，供页面直接访问工具方法