QXS-BNS

Appearance

本页导航

Utils ​

@qxs-bns/utils 提供日期处理、设备检测、上传、存储、请求等通用工具函数，适合按需导入使用。

工具库接入 ​

工具库最适合先从一个真实业务场景切入，例如请求封装或本地存储。
跑通一个 demo 以后，再回头决定要不要继续接日期、设备、上传或水印工具。

loading

本地存储接入 ​

如果你当前页面最先需要的是缓存和本地状态持久化，可以先看 Storage。
它能更直观地展示这个包的命名导入方式和运行时行为。

loading

安装 ​

bash
pnpm add @qxs-bns/utils

导入 ​

ts
import { DateTransfer, Storage } from '@qxs-bns/utils'

const storage = new Storage('demo_')
const dateText = DateTransfer.format(new Date(), 'YYYY-MM-DD')

推荐始终使用 named import，便于 Tree Shaking。useApi、FetchApiService 等请求工具会依赖 axios 或 ky，按实际用法安装对应依赖。

FetchApiService + ky 已升级到 v2

当前文档默认对应 ky@^2.0.0。
ky@2 官方要求 Node >= 22，如果你的项目要使用 FetchApiService 这条链路，请先确认运行时和开发环境满足这个版本要求。

上传相关工具接入前，需要先准备业务侧的凭证或接口能力。

可用能力 ​

工具说明文档
ArgoLog日志工具✅
Storage本地存储✅
DateTransfer日期处理✅
Device设备检测✅
FileOperations文件操作✅
UseApiAPI 请求封装✅
OssUploaderOSS 上传✅
Watermark水印工具✅

常见场景 ​

  • 日期、设备、文件、存储等通用业务逻辑。
  • 需要统一日志、请求封装和上传流程的项目。
  • 希望把工具函数独立于 UI 组件使用的场景。

注意事项 ​

  • 工具库适合和 @qxs-bns/components 或 @qxs-bns/hooks 组合使用。
  • 如果只需要少量能力，优先按需导入单个工具，而不是整包命名空间导入。
  • 请求和上传能力通常还需要业务侧接口、鉴权或上传凭证配合。

下一步 ​