mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
328e3d2a88
* chore(uuid): complete documentation * fmt * tweaks * further tweaks * tweak --------- Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
81 lines
2.0 KiB
TypeScript
81 lines
2.0 KiB
TypeScript
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
|
|
/**
|
|
* Generators and validators for UUIDs for versions v1, v3, v4 and v5.
|
|
*
|
|
* Use {@linkcode crypto.randomUUID} for v4 generating v4 UUIDs.
|
|
*
|
|
* Based on https://github.com/kelektiv/node-uuid -> https://www.ietf.org/rfc/rfc4122.txt
|
|
*
|
|
* Support for RFC4122 version 1, 3, 4, and 5 UUIDs
|
|
*
|
|
* This module is browser compatible.
|
|
*
|
|
* @module
|
|
*/
|
|
|
|
export * from "./constants.ts";
|
|
export * as v1 from "./v1.ts";
|
|
export * as v3 from "./v3.ts";
|
|
export * as v4 from "./v4.ts";
|
|
export * as v5 from "./v5.ts";
|
|
|
|
/**
|
|
* The nil UUID is special form of UUID that is specified to have all 128 bits
|
|
* set to zero.
|
|
*/
|
|
export const NIL_UUID = "00000000-0000-0000-0000-000000000000";
|
|
|
|
/**
|
|
* Check if the passed UUID is the nil UUID.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* import { isNil } from "https://deno.land/std@$STD_VERSION/uuid/mod.ts";
|
|
*
|
|
* isNil("00000000-0000-0000-0000-000000000000"); // true
|
|
* isNil(crypto.randomUUID()); // false
|
|
* ```
|
|
*/
|
|
export function isNil(id: string): boolean {
|
|
return id === NIL_UUID;
|
|
}
|
|
|
|
/**
|
|
* Test a string to see if it is a valid UUID.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* import { validate } from "https://deno.land/std@$STD_VERSION/uuid/mod.ts";
|
|
*
|
|
* validate("not a UUID"); // false
|
|
* validate("6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b"); // true
|
|
* ```
|
|
*/
|
|
export function validate(uuid: string): boolean {
|
|
return /^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000)$/i
|
|
.test(
|
|
uuid,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Detect RFC version of a UUID.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* import { version } from "https://deno.land/std@$STD_VERSION/uuid/mod.ts";
|
|
*
|
|
* version("d9428888-122b-11e1-b85c-61cd3cbb3210"); // 1
|
|
* version("109156be-c4fb-41ea-b1b4-efe1671c5836"); // 4
|
|
* ```
|
|
*/
|
|
export function version(uuid: string): number {
|
|
if (!validate(uuid)) {
|
|
throw new TypeError("Invalid UUID");
|
|
}
|
|
|
|
return parseInt(uuid[14], 16);
|
|
}
|