diff options
author | aakhtar3 <aakhtar3@users.noreply.github.com> | 2020-10-01 05:40:40 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-01 11:40:40 +0200 |
commit | da29ccece5e357b893ce9a5cf145fd6e939c1fb5 (patch) | |
tree | 6216d4ab8da666ae7539c1899d4c55de320a67d0 /std/uuid/v1.ts | |
parent | 326ccb1095adeb9b8c86d42cc9d9d8566bba2788 (diff) |
docs(std/uuid): Added JSdocs for the std/uuid module (#7735)
Diffstat (limited to 'std/uuid/v1.ts')
-rw-r--r-- | std/uuid/v1.ts | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/std/uuid/v1.ts b/std/uuid/v1.ts index ef1882d85..4adb0d6f9 100644 --- a/std/uuid/v1.ts +++ b/std/uuid/v1.ts @@ -6,6 +6,10 @@ const UUID_RE = new RegExp( "i", ); +/** + * Validates the UUID v1 + * @param id UUID value + */ export function validate(id: string): boolean { return UUID_RE.test(id); } @@ -25,6 +29,12 @@ type V1Options = { rng?: () => number[]; }; +/** + * Generates a RFC4122 v1 UUID (time-based) + * @param options Can use RFC time sequence values as overwrites + * @param buf Can allow the UUID to be written in byte-form starting at the offset + * @param offset Index to start writing on the UUID bytes in buffer + */ export function generate( options?: V1Options | null, buf?: number[], |