Skip to content

docs(uuid): document that v7 UUIDs are not monotonic within a millisecond #7286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tomas-zijdemans wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −0
Open

docs(uuid): document that v7 UUIDs are not monotonic within a millisecond #7286

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions uuid/v7.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
*
* UUID Version 7 is defined in {@link https://www.rfc-editor.org/rfc/rfc9562.html#section-5.7 | RFC 9562}.
*
* UUIDv7 values sort by creation time at millisecond precision. Values
* generated within the same millisecond sort in arbitrary order relative to
* each other, see {@linkcode generate} for details.
*
* ```ts
* import { generate, validate, extractTimestamp } from "@std/uuid/v7";
* import { assert, assertEquals } from "@std/assert";
Expand Down Expand Up @@ -46,6 +50,11 @@ export function validate(id: string): boolean {
/**
* Generates a {@link https://www.rfc-editor.org/rfc/rfc9562.html#section-5.7 | UUIDv7}.
*
* All bits after the 48-bit timestamp are random, so UUIDs generated within
* the same millisecond do not sort in generation order: this implementation
* uses none of the optional monotonicity methods of
* {@link https://www.rfc-editor.org/rfc/rfc9562.html#section-6.2 | RFC 9562 section 6.2}.
*
* @throws {RangeError} If the timestamp is not a non-negative integer.
*
* @param timestamp Unix Epoch timestamp in milliseconds.
Expand Down
Loading