summaryrefslogtreecommitdiff
path: root/std/uuid/mod.ts
diff options
context:
space:
mode:
authoraakhtar3 <aakhtar3@users.noreply.github.com>2020-10-01 05:40:40 -0400
committerGitHub <noreply@github.com>2020-10-01 11:40:40 +0200
commitda29ccece5e357b893ce9a5cf145fd6e939c1fb5 (patch)
tree6216d4ab8da666ae7539c1899d4c55de320a67d0 /std/uuid/mod.ts
parent326ccb1095adeb9b8c86d42cc9d9d8566bba2788 (diff)
docs(std/uuid): Added JSdocs for the std/uuid module (#7735)
Diffstat (limited to 'std/uuid/mod.ts')
-rw-r--r--std/uuid/mod.ts7
1 files changed, 6 insertions, 1 deletions
diff --git a/std/uuid/mod.ts b/std/uuid/mod.ts
index 61b10e895..ff20fa807 100644
--- a/std/uuid/mod.ts
+++ b/std/uuid/mod.ts
@@ -1,4 +1,5 @@
-// Based on https://github.com/kelektiv/node-uuid
+// Based on https://github.com/kelektiv/node-uuid -> https://www.ietf.org/rfc/rfc4122.txt
+// Supporting Support for RFC4122 version 1, 4, and 5 UUIDs
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
import * as v1 from "./v1.ts";
import * as v4 from "./v4.ts";
@@ -6,6 +7,10 @@ import * as v5 from "./v5.ts";
export const NIL_UUID = "00000000-0000-0000-0000-000000000000";
+/**
+ * Checks if UUID is nil
+ * @param val UUID value
+ */
export function isNil(val: string): boolean {
return val === NIL_UUID;
}