logo
0
0
WeChat Login

Elevator-JS 文档

一个高质量的 JavaScript 工具函数库

📚 组件列表

🔧 核心工具

组件描述文档链接版本
stringify智能对象字符串化工具详细文档v1.0.0

🚀 快速开始

安装

npm install elevator-js # 或 yarn add elevator-js # 或 bun add elevator-js

基本使用

// ESM 导入 import { stringify } from 'elevator-js'; // 或者按需导入 import { stringify } from 'elevator-js/stringify'; // 使用 const result = stringify({ name: 'test', value: 42 }); console.log(result); // "{ name: "test", value: 42 }"

浏览器使用

<!-- 通过 CDN 使用 IIFE 格式 --> <script src="https://your-cdn.com/elevator-js/iife/stringify/index.js"></script> <script> console.log(stringify({ hello: 'world' })); </script>

📦 包管理

项目支持两种使用方式:

🏗️ 独立包结构

每个组件都是独立的 npm 包,可以单独安装和使用:

# 安装独立包 npm install @elevator-js/stringify # 使用独立包 import { stringify } from '@elevator-js/stringify';

🎯 主包使用

也可以使用主包,包含所有组件:

# 安装主包 npm install elevator-js # 使用主包 import { stringify } from 'elevator-js'; import { stringify } from 'elevator-js/stringify';

🔧 构建格式

每个包都提供三种构建格式:

1. Node.js ESM 格式 (dist/package-name/)

  • 适用于 Node.js 环境
  • 向后兼容
  • 完整的类型支持

2. Browser ESM 格式 (dist/esm/package-name/)

  • 适用于现代打包工具 (Webpack, Vite, Rollup)
  • 支持 Tree Shaking
  • 包含完整的 TypeScript 类型定义

3. Browser IIFE 格式 (dist/iife/package-name/)

  • 适用于浏览器直接使用
  • 包含 sourcemap 文件,便于调试
  • 代码已压缩优化

🛠️ 构建命令

单包构建

# 构建指定包 bun run build:package stringify # 在包目录内构建 cd packages/stringify && bun run build

批量构建

# 构建所有包 bun run build

开发模式

# 监听单个包变化 bun run build:package stringify --watch # 在包目录内开发 cd packages/stringify && bun run dev

🧪 测试覆盖率

组件测试覆盖率测试用例数性能基准
stringify98%+60+< 0.01ms/op

📖 详细文档

每个组件都有详细的文档,包含:

  • 🎯 基础功能 - 核心特性和用途
  • 📝 使用方法 - 完整的 API 文档和示例
  • 🧪 测试用例 - 全面的测试覆盖
  • 📊 测试结果 - 性能基准和覆盖率报告
  • 📋 变更日志 - 版本更新记录

🔗 相关链接

📄 许可证

MIT License - 详见 LICENSE 文件


🤝 贡献

欢迎提交 Issue 和 Pull Request!

  1. Fork 本仓库
  2. 创建特性分支 (git checkout -b feature/amazing-feature)
  3. 提交更改 (git commit -m 'Add some amazing feature')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 开启 Pull Request

📞 支持

如果您在使用过程中遇到问题,可以通过以下方式获取帮助: