1<!-- 2 -- This file is auto-generated from README_js.md. Changes should be made there. 3 --> 4 5# uuid [](http://travis-ci.org/kelektiv/node-uuid) # 6 7Simple, fast generation of [RFC4122](http://www.ietf.org/rfc/rfc4122.txt) UUIDS. 8 9Features: 10 11* Support for version 1, 3, 4 and 5 UUIDs 12* Cross-platform 13* Uses cryptographically-strong random number APIs (when available) 14* Zero-dependency, small footprint (... but not [this small](https://gist.github.com/982883)) 15 16[**Deprecation warning**: The use of `require('uuid')` is deprecated and will not be 17supported after version 3.x of this module. Instead, use `require('uuid/[v1|v3|v4|v5]')` as shown in the examples below.] 18 19## Quickstart - CommonJS (Recommended) 20 21```shell 22npm install uuid 23``` 24 25Then generate your uuid version of choice ... 26 27Version 1 (timestamp): 28 29```javascript 30const uuidv1 = require('uuid/v1'); 31uuidv1(); // ⇨ '2c5ea4c0-4067-11e9-8bad-9b1deb4d3b7d' 32 33``` 34 35Version 3 (namespace): 36 37```javascript 38const uuidv3 = require('uuid/v3'); 39 40// ... using predefined DNS namespace (for domain names) 41uuidv3('hello.example.com', uuidv3.DNS); // ⇨ '9125a8dc-52ee-365b-a5aa-81b0b3681cf6' 42 43// ... using predefined URL namespace (for, well, URLs) 44uuidv3('http://example.com/hello', uuidv3.URL); // ⇨ 'c6235813-3ba4-3801-ae84-e0a6ebb7d138' 45 46// ... using a custom namespace 47// 48// Note: Custom namespaces should be a UUID string specific to your application! 49// E.g. the one here was generated using this modules `uuid` CLI. 50const MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341'; 51uuidv3('Hello, World!', MY_NAMESPACE); // ⇨ 'e8b5a51d-11c8-3310-a6ab-367563f20686' 52 53``` 54 55Version 4 (random): 56 57```javascript 58const uuidv4 = require('uuid/v4'); 59uuidv4(); // ⇨ '1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed' 60 61``` 62 63Version 5 (namespace): 64 65```javascript 66const uuidv5 = require('uuid/v5'); 67 68// ... using predefined DNS namespace (for domain names) 69uuidv5('hello.example.com', uuidv5.DNS); // ⇨ 'fdda765f-fc57-5604-a269-52a7df8164ec' 70 71// ... using predefined URL namespace (for, well, URLs) 72uuidv5('http://example.com/hello', uuidv5.URL); // ⇨ '3bbcee75-cecc-5b56-8031-b6641c1ed1f1' 73 74// ... using a custom namespace 75// 76// Note: Custom namespaces should be a UUID string specific to your application! 77// E.g. the one here was generated using this modules `uuid` CLI. 78const MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341'; 79uuidv5('Hello, World!', MY_NAMESPACE); // ⇨ '630eb68f-e0fa-5ecc-887a-7c7a62614681' 80 81``` 82 83## Quickstart - Browser-ready Versions 84 85Browser-ready versions of this module are available via [wzrd.in](https://github.com/jfhbrook/wzrd.in). 86 87For version 1 uuids: 88 89```html 90<script src="http://wzrd.in/standalone/uuid%2Fv1@latest"></script> 91<script> 92uuidv1(); // -> v1 UUID 93</script> 94``` 95 96For version 3 uuids: 97 98```html 99<script src="http://wzrd.in/standalone/uuid%2Fv3@latest"></script> 100<script> 101uuidv3('http://example.com/hello', uuidv3.URL); // -> v3 UUID 102</script> 103``` 104 105For version 4 uuids: 106 107```html 108<script src="http://wzrd.in/standalone/uuid%2Fv4@latest"></script> 109<script> 110uuidv4(); // -> v4 UUID 111</script> 112``` 113 114For version 5 uuids: 115 116```html 117<script src="http://wzrd.in/standalone/uuid%2Fv5@latest"></script> 118<script> 119uuidv5('http://example.com/hello', uuidv5.URL); // -> v5 UUID 120</script> 121``` 122 123## API 124 125### Version 1 126 127```javascript 128const uuidv1 = require('uuid/v1'); 129 130// Incantations 131uuidv1(); 132uuidv1(options); 133uuidv1(options, buffer, offset); 134``` 135 136Generate and return a RFC4122 v1 (timestamp-based) UUID. 137 138* `options` - (Object) Optional uuid state to apply. Properties may include: 139 140 * `node` - (Array) Node id as Array of 6 bytes (per 4.1.6). Default: Randomly generated ID. See note 1. 141 * `clockseq` - (Number between 0 - 0x3fff) RFC clock sequence. Default: An internally maintained clockseq is used. 142 * `msecs` - (Number) Time in milliseconds since unix Epoch. Default: The current time is used. 143 * `nsecs` - (Number between 0-9999) additional time, in 100-nanosecond units. Ignored if `msecs` is unspecified. Default: internal uuid counter is used, as per 4.2.1.2. 144 145* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. 146* `offset` - (Number) Starting index in `buffer` at which to begin writing. 147 148Returns `buffer`, if specified, otherwise the string form of the UUID 149 150Note: 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. 151 152Example: Generate string UUID with fully-specified options 153 154```javascript 155const v1options = { 156 node: [0x01, 0x23, 0x45, 0x67, 0x89, 0xab], 157 clockseq: 0x1234, 158 msecs: new Date('2011-11-01').getTime(), 159 nsecs: 5678 160}; 161uuidv1(v1options); // ⇨ '710b962e-041c-11e1-9234-0123456789ab' 162 163``` 164 165Example: In-place generation of two binary IDs 166 167```javascript 168// Generate two ids in an array 169const arr = new Array(); 170uuidv1(null, arr, 0); // ⇨ [ 44, 94, 164, 192, 64, 103, 17, 233, 146, 52, 155, 29, 235, 77, 59, 125 ] 171uuidv1(null, arr, 16); // ⇨ [ 44, 94, 164, 192, 64, 103, 17, 233, 146, 52, 155, 29, 235, 77, 59, 125, 44, 94, 164, 193, 64, 103, 17, 233, 146, 52, 155, 29, 235, 77, 59, 125 ] 172 173``` 174 175### Version 3 176 177```javascript 178const uuidv3 = require('uuid/v3'); 179 180// Incantations 181uuidv3(name, namespace); 182uuidv3(name, namespace, buffer); 183uuidv3(name, namespace, buffer, offset); 184``` 185 186Generate and return a RFC4122 v3 UUID. 187 188* `name` - (String | Array[]) "name" to create UUID with 189* `namespace` - (String | Array[]) "namespace" UUID either as a String or Array[16] of byte values 190* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. 191* `offset` - (Number) Starting index in `buffer` at which to begin writing. Default = 0 192 193Returns `buffer`, if specified, otherwise the string form of the UUID 194 195Example: 196 197```javascript 198uuidv3('hello world', MY_NAMESPACE); // ⇨ '042ffd34-d989-321c-ad06-f60826172424' 199 200``` 201 202### Version 4 203 204```javascript 205const uuidv4 = require('uuid/v4') 206 207// Incantations 208uuidv4(); 209uuidv4(options); 210uuidv4(options, buffer, offset); 211``` 212 213Generate and return a RFC4122 v4 UUID. 214 215* `options` - (Object) Optional uuid state to apply. Properties may include: 216 * `random` - (Number[16]) Array of 16 numbers (0-255) to use in place of randomly generated values 217 * `rng` - (Function) Random # generator function that returns an Array[16] of byte values (0-255) 218* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. 219* `offset` - (Number) Starting index in `buffer` at which to begin writing. 220 221Returns `buffer`, if specified, otherwise the string form of the UUID 222 223Example: Generate string UUID with predefined `random` values 224 225```javascript 226const v4options = { 227 random: [ 228 0x10, 0x91, 0x56, 0xbe, 0xc4, 0xfb, 0xc1, 0xea, 229 0x71, 0xb4, 0xef, 0xe1, 0x67, 0x1c, 0x58, 0x36 230 ] 231}; 232uuidv4(v4options); // ⇨ '109156be-c4fb-41ea-b1b4-efe1671c5836' 233 234``` 235 236Example: Generate two IDs in a single buffer 237 238```javascript 239const buffer = new Array(); 240uuidv4(null, buffer, 0); // ⇨ [ 155, 29, 235, 77, 59, 125, 75, 173, 155, 221, 43, 13, 123, 61, 203, 109 ] 241uuidv4(null, buffer, 16); // ⇨ [ 155, 29, 235, 77, 59, 125, 75, 173, 155, 221, 43, 13, 123, 61, 203, 109, 27, 157, 107, 205, 187, 253, 75, 45, 155, 93, 171, 141, 251, 189, 75, 237 ] 242 243``` 244 245### Version 5 246 247```javascript 248const uuidv5 = require('uuid/v5'); 249 250// Incantations 251uuidv5(name, namespace); 252uuidv5(name, namespace, buffer); 253uuidv5(name, namespace, buffer, offset); 254``` 255 256Generate and return a RFC4122 v5 UUID. 257 258* `name` - (String | Array[]) "name" to create UUID with 259* `namespace` - (String | Array[]) "namespace" UUID either as a String or Array[16] of byte values 260* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. 261* `offset` - (Number) Starting index in `buffer` at which to begin writing. Default = 0 262 263Returns `buffer`, if specified, otherwise the string form of the UUID 264 265Example: 266 267```javascript 268uuidv5('hello world', MY_NAMESPACE); // ⇨ '9f282611-e0fd-5650-8953-89c8e342da0b' 269 270``` 271 272## Command Line 273 274UUIDs can be generated from the command line with the `uuid` command. 275 276```shell 277$ uuid 278ddeb27fb-d9a0-4624-be4d-4615062daed4 279 280$ uuid v1 28102d37060-d446-11e7-a9fa-7bdae751ebe1 282``` 283 284Type `uuid --help` for usage details 285 286## Testing 287 288```shell 289npm test 290``` 291 292---- 293Markdown generated from [README_js.md](README_js.md) by [](https://github.com/broofa/runmd)
){kind=link}
){kind=link}