UUID.js 技术文档：RFC兼容的JavaScript UUID生成器

UUID.js 技术文档：RFC兼容的JavaScript UUID生成器

UUID.js RFC-compliant UUID Generator for JavaScript 项目地址: https://gitcode.com/gh_mirrors/uu/UUID.js

UUID.js是一个遵循[RFC 9562]标准的JavaScript库，用于生成通用唯一标识符（Universally Unique IDentifiers, UUID）。它支持多种版本的UUID生成，包括随机数基础的UUIDv4，基于格里高利时间的UUIDv1和重新排序的时间基础UUIDv6。此文档旨在提供详细指导，帮助开发者了解并有效利用UUID.js。

安装指南

Node.js环境

在Node.js环境中，您可以通过npm来安装UUID.js：

npm install uuidjs

之后，在您的代码中通过导入模块来使用：

import { UUID } from 'uuidjs';

浏览器环境

对于Web应用，可以直接通过CDN链接引入：

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

或者在非模块化环境使用传统脚本标签：

<script src="https://unpkg.com/uuidjs@^5/dist/umd/UUID.min.js"></script>

命令行工具

如果您希望直接从命令行生成UUID，可以执行：

npx uuidjs

项目使用说明

生成UUIDv4

基本的UUIDv4字符串生成非常简单，如下所示：

const uuidStr = UUID.generate();
console.log(uuidStr);

使用UUID对象

UUID.js不仅生成字符串，还提供了UUID对象，以便于访问其不同属性和方法：

const objV4 = UUID.genV4();
console.log(`Version: ${objV4.version}`); // 输出版本号
console.log(objV4.toString()); // 获得字符串表示

版本特定的生成与解析

• UUIDv1：

  const v1Obj = UUID.genV1();
  

• UUIDv6：

  const v6Obj = UUID.genV6();
  

• 从字符串解析UUID：

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

比较与检查UUID

您可以比较两个UUID对象是否相等，并获取UUID的详情：

const uuidOne = UUID.parse('some-uuid-string');
const uuidTwo = UUID.parse('another-uuid-string');
console.log(uuidOne.equals(uuidTwo)); // 检查两个UUID是否相同

API使用文档

UUID.js提供了以下主要接口：

• UUID.generate() - 返回一个UUIDv4字符串。
• { UUID }.genV4(), genV1(), genV6() - 分别生成UUIDv4, v1, v6的对象实例。
• { UUID }.parse(hexString) - 将十六进制字符串转换为UUID对象。
• { UUIDObject }.toString() - 获取UUID的完整字符串形式。
• { UUIDObject }.hexString, hexNoDelim, bitString, urn - 不同格式的UUID表示。
• { UUIDObject }.version - 获取UUID的版本号。
• { UUIDObject }.equals(otherUUID) - 判断两个UUID是否相等。

许可证

UUID.js的使用受Apache License 2.0条款约束，更多细节请查看项目的LICENSE文件或访问LICENSE页面。

---

以上即为UUID.js的基础使用和技术文档概览，希望对您的开发工作有所帮助。

UUID.js RFC-compliant UUID Generator for JavaScript 项目地址: https://gitcode.com/gh_mirrors/uu/UUID.js