UUID.js 技术文档

1. 安装指南

NPM 安装

您可以通过 NPM 来安装 UUID.js。在您的项目中运行以下命令：

npm install uuidjs

Yarn 安装

如果您使用 Yarn 作为包管理工具，可以使用以下命令安装：

yarn add uuidjs

直接在浏览器中使用

您还可以直接在浏览器中通过 CDN 链接使用 UUID.js：

<script type="module">
  import { UUID } from "https://unpkg.com/uuidjs@^5";
  const uuid = UUID.generate();
</script>

2. 项目的使用说明

UUID.js 是一个用于生成符合 RFC 9562 标准的通用唯一识别码（UUID）的 JavaScript/ECMAScript 库。该库支持 UUIDv4（基于随机数的 UUID）、UUIDv1（基于公历时间的 UUID）和 UUIDv6（重新排序的基于公历时间的 UUID）。此外，它还提供了一个面向对象的接口，用于打印生成或解析的 UUID 的多种字符串表示形式。

3. 项目 API 使用文档

以下是 UUID.js 库的一些主要 API 方法：

UUID.generate()

生成一个 UUIDv4 作为十六进制字符串。

const uuid = UUID.generate();
console.log(uuid); // 输出格式类似于：fa84cf42-ffdf-4975-b42b-31ab5fb983eb

UUID.genV4()

生成一个 UUIDv4 对象。

const objV4 = UUID.genV4();

UUID.genV1()

生成一个 UUIDv1 对象。

const objV1 = UUID.genV1();

UUID.genV6()

生成一个 UUIDv6 对象。

const objV6 = UUID.genV6();

UUID.parse()

从一个十六进制字符串解析一个 UUID 对象。

const uuid = UUID.parse("a0e0f130-8c21-11df-92d9-95795a3bcd40");

UUID 对象方法

• toString()：返回 UUID 的字符串表示形式。
• hexString：返回 UUID 的十六进制字符串形式。
• hexNoDelim：返回没有分隔符的 UUID 十六进制字符串。
• bitString：返回 UUID 的位字符串表示形式。
• urn：返回 UUID 的 URN 表示形式。

console.log(uuid.toString());       // "a0e0f130-8c21-11df-92d9-95795a3bcd40"
console.log(uuid.hexString);        // "a0e0f130-8c21-11df-92d9-95795a3bcd40"
console.log(uuid.hexNoDelim);       // "a0e0f1308c2111df92d995795a3bcd40"
console.log(uuid.bitString);        // "101000001110000 ... 1100110101000000"
console.log(uuid.urn);              // "urn:uuid:a0e0f130-8c21-11df-92d9-95795a3bcd40"

// 比较两个 UUID 对象
console.log(objV4.equals(objV1));    // false

// 获取 UUID 版本号
console.log(objV4.version);         // 4
console.log(objV1.version);         // 1
console.log(objV6.version);         // 6

4. 项目安装方式

请参考上述的“安装指南”部分，了解如何通过 NPM、Yarn 或直接在浏览器中安装和使用 UUID.js。