Skip to content

docs: fix stale v1, v6, v7 and CLI details in README #991

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

Merged
broofa merged 1 commit into from
Nov 1, 2026
Merged

docs: fix stale v1, v6, v7 and CLI details in README #991

Show file tree
Hide file tree
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,13 +166,12 @@ Create an RFC version 1 (timestamp) UUID
| [`options.node = (random)` ] | RFC "node" field as an `Array[6]` of byte values (per 4.1.6) |
| [`options.clockseq = (random)`] | RFC "clock sequence" as a `Number` between 0 - 0x3fff |
| [`options.msecs = (current time)`] | RFC "timestamp" field (`Number` of milliseconds, unix epoch) |
| [`options.nsecs = 0`] | RFC "timestamp" field (`Number` of nanoseconds to add to `msecs`, should be 0-10,000) |
| [`options.nsecs = 0`] | RFC "timestamp" field (`Number` of 100-nanosecond intervals to add to `msecs`, should be 0-9,999) |
| [`options.random = (random)`] | `Array` of 16 random bytes (0-255) used to generate other fields, above |
| [`options.rng`] | Alternative to `options.random`, a `Function` that returns an `Array` of 16 random bytes (0-255) |
| [`buffer`] | `Uint8Array` or `Uint8Array` subtype (e.g. Node.js `Buffer`). If provided, binary UUID is written into the array, starting at `offset` |
| [`offset` = 0] | `Number` Index to start writing UUID bytes in `buffer` |
| _returns_ | UUID `String` if no `buffer` is specified, otherwise returns `buffer` |
| _throws_ | `Error` if more than 10M UUIDs/sec are requested |

Example:

Expand Down Expand Up @@ -310,7 +309,7 @@ This method takes the same arguments as uuid.v1().
```javascript
import { v6 as uuidv6 } from 'uuid';

uuidv6(); // ⇨ '1efc7d35-7fd0-6000-841d-504d2167fc5b'
uuidv6(); // ⇨ '1efc7d35-7fd0-6000-841d-514d2167fc5b'
```

Example using `options`:
Expand All @@ -319,7 +318,7 @@ Example using `options`:
import { v6 as uuidv6 } from 'uuid';

const options = {
node: [0x01, 0x23, 0x45, 0x67, 0x89, 0xab],
node: Uint8Array.of(0x01, 0x23, 0x45, 0x67, 0x89, 0xab),
clockseq: 0x1234,
msecs: new Date('2011-11-01').getTime(),
nsecs: 5678,
Expand All @@ -339,7 +338,7 @@ v6ToV1('1ef22c49-2f62-6d9e-97e9-325096b39f47'); // ⇨ '92f62d9e-22c4-11ef-97e9-

### uuid.v7([options[, buffer[, offset]]])

Create an RFC version 7 (random) UUID
Create an RFC version 7 (Unix Epoch time-based) UUID

| | |
| --- | --- |
Expand Down Expand Up @@ -446,6 +445,7 @@ Usage:
uuid v3 <name> <namespace uuid>
uuid v4
uuid v5 <name> <namespace uuid>
uuid v6
uuid v7
uuid --help

Expand All @@ -464,7 +464,7 @@ Prior to `uuid@11`, it was possible for `options` state to interfere with the in

**Browsers**: `uuid` [builds are tested](/uuidjs/uuid/blob/main/wdio.conf.js) against the latest version of desktop Chrome, Safari, Firefox, and Edge. Mobile versions of these same browsers are expected to work but aren't currently tested.

**Node**: `uuid` releases are tested against [Node LTS versions](https://github.com/nodejs/Release), plus one prior. (E.g. At the time of this writing the oldest LTS version of Node is `node@22`, so `uuid` would support back to `node@20`)
**Node**: `uuid` releases are tested against [Node LTS versions](https://github.com/nodejs/Release), plus one prior. (E.g. At the time of this writing the oldest LTS version of Node is `node@22`, so `uuid` would support back to `node@20`)

**Typescript**: TS versions released within the past two years are supported. [source](https://github.com/microsoft/TypeScript/issues/49088#issuecomment-2468723715)

Expand Down
10 changes: 5 additions & 5 deletions README_js.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,13 +195,12 @@ Create an RFC version 1 (timestamp) UUID
| [`options.node = (random)` ] | RFC "node" field as an `Array[6]` of byte values (per 4.1.6) |
| [`options.clockseq = (random)`] | RFC "clock sequence" as a `Number` between 0 - 0x3fff |
| [`options.msecs = (current time)`] | RFC "timestamp" field (`Number` of milliseconds, unix epoch) |
| [`options.nsecs = 0`] | RFC "timestamp" field (`Number` of nanoseconds to add to `msecs`, should be 0-10,000) |
| [`options.nsecs = 0`] | RFC "timestamp" field (`Number` of 100-nanosecond intervals to add to `msecs`, should be 0-9,999) |
| [`options.random = (random)`] | `Array` of 16 random bytes (0-255) used to generate other fields, above |
| [`options.rng`] | Alternative to `options.random`, a `Function` that returns an `Array` of 16 random bytes (0-255) |
| [`buffer`] | `Uint8Array` or `Uint8Array` subtype (e.g. Node.js `Buffer`). If provided, binary UUID is written into the array, starting at `offset` |
| [`offset` = 0] | `Number` Index to start writing UUID bytes in `buffer` |
| _returns_ | UUID `String` if no `buffer` is specified, otherwise returns `buffer` |
| _throws_ | `Error` if more than 10M UUIDs/sec are requested |

Example:

Expand Down Expand Up @@ -348,7 +347,7 @@ Example using `options`:
import { v6 as uuidv6 } from 'uuid';

const options = {
node: [0x01, 0x23, 0x45, 0x67, 0x89, 0xab],
node: Uint8Array.of(0x01, 0x23, 0x45, 0x67, 0x89, 0xab),
clockseq: 0x1234,
msecs: new Date('2011-11-01').getTime(),
nsecs: 5678,
Expand All @@ -368,7 +367,7 @@ v6ToV1('1ef22c49-2f62-6d9e-97e9-325096b39f47'); // RESULT

### uuid.v7([options[, buffer[, offset]]])

Create an RFC version 7 (random) UUID
Create an RFC version 7 (Unix Epoch time-based) UUID

| | |
| --- | --- |
Expand Down Expand Up @@ -475,6 +474,7 @@ Usage:
uuid v3 <name> <namespace uuid>
uuid v4
uuid v5 <name> <namespace uuid>
uuid v6
uuid v7
uuid --help

Expand All @@ -493,7 +493,7 @@ Prior to `uuid@11`, it was possible for `options` state to interfere with the in

**Browsers**: `uuid` [builds are tested](/uuidjs/uuid/blob/main/wdio.conf.js) against the latest version of desktop Chrome, Safari, Firefox, and Edge. Mobile versions of these same browsers are expected to work but aren't currently tested.

**Node**: `uuid` [builds are tested](https://github.com/uuidjs/uuid/blob/main/.github/workflows/ci.yml#L31) against node ([LTS releases](https://github.com/nodejs/Release)), plus one prior. E.g. At the time of this writing `node@20` is the "maintenance" release and `node@24` is the "current" release, so `uuid` supports `node@20`-`node@24`.
**Node**: `uuid` releases are tested against [Node LTS versions](https://github.com/nodejs/Release), plus one prior. (E.g. At the time of this writing the oldest LTS version of Node is `node@22`, so `uuid` would support back to `node@20`)

**Typescript**: TS versions released within the past two years are supported. [source](https://github.com/microsoft/TypeScript/issues/49088#issuecomment-2468723715)

Expand Down
Loading