JS-quantities 技术文档

本文档旨在帮助用户安装、使用和详细了解 JS-quantities 项目，以下是项目的技术文档。

1. 安装指南

使用 npm 安装

在命令行中执行以下命令：

npm install js-quantities

手动下载

从以下链接下载最新版本（v1.8.0）：

• UMD 模块
• ES 模块

2. 项目的使用说明

Node.js 使用方法

CommonJS 模块

const Qty = require('js-quantities');

ES 模块

import Qty from 'js-quantities';

浏览器中使用方法

UMD 模块

直接在 HTML 文件中引用：

<script src='quantities.js'></script>

此时，将定义一个全局变量 Qty。

使用 AMD 加载器（如 Require.JS）

define(['quantities'], function(Qty) {
  ...
});

ES 模块

<script type="module">
  import Qty from "./path/to/quantities.mjs";
  // ...
</script>

3. 项目 API 使用文档

创建实例

通过 Qty() 方法创建量的实例。Qty 可以作为构造函数（使用 new）或工厂方法（不使用 new）使用：

qty = new Qty('23 ft'); // 构造函数
qty = Qty('23 ft'); // 工厂方法

Qty 构造函数接受字符串、数字和 Qty 实例作为初始化值。

如果标量和它们的单位是程序化可用的，则双参数签名可能很有用：

qty = new Qty(124, 'cm'); // => 1.24 米
qty = Qty(124, 'cm'); // => 1.24 米

为了简单起见，下面将使用工厂方法，但使用 new Qty() 是等效的。

qty = Qty('1m'); // => 1 米
qty = Qty('m'); // => 1 米（标量默认为 1）

其他方法和查询

• Qty.parse(): 解析字符串并创建量。如果解析无效的量，它将返回 null 而不是抛出错误。
• Qty.getKinds(): 返回所有已知单位的种类名称数组。
• Qty.getUnits(): 返回特定种类的单位或所有单位的字母顺序数组。
• Qty.getAliases(): 返回特定单位的替代名称数组。

量之间的比较、转换、运算、四舍五入和格式化等方法也在文档中有详细说明。

4. 项目安装方式

请参考本文档的“安装指南”部分，其中详细介绍了使用 npm 安装或手动下载安装 JS-quantities 的方法。