Skip to content

Commit f24c530

Browse files
pmccarrenpmccarren
authored
docs: updates for RFC9562 (#753)
1 parent 59c2711 commit f24c530

5 files changed

Lines changed: 15 additions & 16 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22
-- This file is auto-generated from README_js.md. Changes should be made there.
33
-->
44

5-
65
# uuid [![CI](https://github.com/uuidjs/uuid/workflows/CI/badge.svg)](https://github.com/uuidjs/uuid/actions?query=workflow%3ACI) [![Browser](https://github.com/uuidjs/uuid/workflows/Browser/badge.svg)](https://github.com/uuidjs/uuid/actions?query=workflow%3ABrowser)
76

8-
For the creation of [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) UUIDs
7+
For the creation of [RFC9562](https://www.rfc-editor.org/rfc/rfc9562.html) (formally [RFC4122](https://www.rfc-editor.org/rfc/rfc4122.html)) UUIDs
98

10-
- **Complete** - Support for RFC4122 version 1, 3, 4, 5, and 7 UUIDs
9+
- **Complete** - Support for all RFC9562 UUID versions
1110
- **Cross-platform** - Support for ...
1211
- CommonJS, [ECMAScript Modules](#ecmascript-modules) and [CDN builds](#cdn-builds)
1312
- NodeJS 16+ ([LTS releases](https://github.com/nodejs/Release))
@@ -173,7 +172,7 @@ Create an RFC version 1 (timestamp) UUID
173172

174173
<!-- prettier-ignore -->
175174
> [!NOTE]
176-
> The default [node id](https://tools.ietf.org/html/rfc4122#section-4.1.6) (the last 12 digits in the UUID) is generated once, randomly, on process startup, and then remains unchanged for the duration of the process.
175+
> The default [node id](https://datatracker.ietf.org/doc/html/rfc9562#section-5.1) (the last 12 digits in the UUID) is generated once, randomly, on process startup, and then remains unchanged for the duration of the process.
177176
178177
<!-- prettier-ignore -->
179178
> [!NOTE]
@@ -386,7 +385,7 @@ Usage:
386385
uuid --help
387386

388387
Note: <namespace uuid> may be "URL" or "DNS" to use the corresponding UUIDs
389-
defined by RFC4122
388+
defined by RFC9562
390389
```
391390

392391
## ECMAScript Modules
@@ -521,6 +520,5 @@ const uuid = require('uuid'); // <== REMOVED!
521520

522521
This usage pattern was already discouraged in `uuid@3` and has been removed in `uuid@7`.
523522

524-
---
525-
526-
Markdown generated from [README_js.md](README_js.md) by <a href="https://github.com/broofa/runmd"><image height="12px" src="https://camo.githubusercontent.com/5c7c603cd1e6a43370b0a5063d457e0dabb74cf317adc7baba183acb686ee8d0/687474703a2f2f692e696d6775722e636f6d2f634a4b6f3662552e706e67" /></a>
523+
----
524+
Markdown generated from [README_js.md](README_js.md) by [![RunMD Logo](https://i.imgur.com/h0FVyzU.png)](https://github.com/broofa/runmd)

‎README_js.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ require('crypto').randomUUID = undefined;
1919

2020
# uuid [![CI](https://github.com/uuidjs/uuid/workflows/CI/badge.svg)](https://github.com/uuidjs/uuid/actions?query=workflow%3ACI) [![Browser](https://github.com/uuidjs/uuid/workflows/Browser/badge.svg)](https://github.com/uuidjs/uuid/actions?query=workflow%3ABrowser)
2121

22-
For the creation of [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) UUIDs
22+
For the creation of [RFC9562](https://www.rfc-editor.org/rfc/rfc9562.html) (formally [RFC4122](https://www.rfc-editor.org/rfc/rfc4122.html)) UUIDs
2323

24-
- **Complete** - Support for RFC4122 version 1, 3, 4, 5, and 7 UUIDs
24+
- **Complete** - Support for RFC9562 version 1, 3, 4, 5, and 7 UUIDs
2525
- **Cross-platform** - Support for ...
2626
- CommonJS, [ECMAScript Modules](#ecmascript-modules) and [CDN builds](#cdn-builds)
2727
- NodeJS 16+ ([LTS releases](https://github.com/nodejs/Release))
@@ -181,7 +181,7 @@ Create an RFC version 1 (timestamp) UUID
181181

182182
<!-- prettier-ignore -->
183183
> [!NOTE]
184-
> The default [node id](https://tools.ietf.org/html/rfc4122#section-4.1.6) (the last 12 digits in the UUID) is generated once, randomly, on process startup, and then remains unchanged for the duration of the process.
184+
> The default [node id](https://datatracker.ietf.org/doc/html/rfc9562#section-5.1) (the last 12 digits in the UUID) is generated once, randomly, on process startup, and then remains unchanged for the duration of the process.
185185
186186
<!-- prettier-ignore -->
187187
> [!NOTE]
@@ -394,7 +394,7 @@ Usage:
394394
uuid --help
395395

396396
Note: <namespace uuid> may be "URL" or "DNS" to use the corresponding UUIDs
397-
defined by RFC4122
397+
defined by RFC9562
398398
```
399399

400400
## ECMAScript Modules

‎examples/benchmark/benchmark.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export default function benchmark(uuid, Benchmark) {
4646
try {
4747
uuid.v1(null, array, 0);
4848
} catch (err) {
49-
// The spec (https://tools.ietf.org/html/rfc4122#section-4.2.1.2) defines that only 10M/s v1
49+
// The spec (https://datatracker.ietf.org/doc/html/rfc9562#name-timestamp-considerations) defines that only 10M/s v1
5050
// UUIDs can be generated on a single node. This library throws an error if we hit that limit
5151
// (which can happen on modern hardware and modern Node.js versions).
5252
}

‎package.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "uuid",
33
"version": "9.0.1",
4-
"description": "RFC4122 (v1, v3, v4, v5, and v7) UUIDs",
4+
"description": "RFC9562 UUIDs",
55
"funding": [
66
"https://github.com/sponsors/broofa",
77
"https://github.com/sponsors/ctavan"
@@ -14,7 +14,8 @@
1414
"keywords": [
1515
"uuid",
1616
"guid",
17-
"rfc4122"
17+
"rfc4122",
18+
"rfc9562"
1819
],
1920
"license": "MIT",
2021
"bin": {

‎src/uuid-bin.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ function usage() {
1616
console.log(' uuid v7');
1717
console.log(' uuid --help');
1818
console.log(
19-
'\nNote: <namespace uuid> may be "URL" or "DNS" to use the corresponding UUIDs defined by RFC4122'
19+
'\nNote: <namespace uuid> may be "URL" or "DNS" to use the corresponding UUIDs defined by RFC9562'
2020
);
2121
}
2222

0 commit comments

Comments
 (0)