Name: node-uuid
Owner: Mozilla-B2G
Description: Generate RFC-compliant UUIDs in JavaScript
Created: 2014-10-28 18:14:40.0
Updated: 2016-11-14 17:11:05.0
Pushed: 2014-10-28 18:23:11.0
Size: 673
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Simple, fast generation of RFC4122 UUIDS.
Features:
Install it in your browser:
ipt src="uuid.js"></script>
Or in node.js:
install node-uuid
avascript
uuid = require('node-uuid');
Then create some ids …
enerate a v1 (time-based) id
.v1(); // -> '6c84fb90-12c4-11e1-840d-7b25c5ee775a'
enerate a v4 (random) id
.v4(); // -> '110ec58a-a0f2-4ac4-8393-c866d813b8d1'
options [, buffer [, offset]]])Generate and return a RFC4122 v1 (timestamp-based) UUID.
options - (Object) Optional uuid state to apply. Properties may include:
node - (Array) Node id as Array of 6 bytes (per 4.1.6). Default: Randomly generated ID. See note 1.
clockseq - (Number between 0 - 0x3fff) RFC clock sequence. Default: An internally maintained clockseq is used.
msecs - (Number | Date) Time in milliseconds since unix Epoch. Default: The current time is used.
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.
buffer - (Array | Buffer) Array or buffer where UUID bytes are to be written.
offset - (Number) Starting index in buffer at which to begin writing.
Returns buffer, if specified, otherwise the string form of the UUID
Notes:
Example: Generate string UUID with fully-specified options
.v1({
de: [0x01, 0x23, 0x45, 0x67, 0x89, 0xab],
ockseq: 0x1234,
ecs: new Date('2011-11-01').getTime(),
ecs: 5678
// -> "710b962e-041c-11e1-9234-0123456789ab"
Example: In-place generation of two binary IDs
enerate two ids in an array
arr = new Array(32); // -> []
.v1(null, arr, 0); // -> [02 a2 ce 90 14 32 11 e1 85 58 0b 48 8e 4f c1 15]
.v1(null, arr, 16); // -> [02 a2 ce 90 14 32 11 e1 85 58 0b 48 8e 4f c1 15 02 a3 1c b0 14 32 11 e1 85 58 0b 48 8e 4f c1 15]
ptionally use uuid.unparse() to get stringify the ids
.unparse(buffer); // -> '02a2ce90-1432-11e1-8558-0b488e4fc115'
.unparse(buffer, 16) // -> '02a31cb0-1432-11e1-8558-0b488e4fc115'
options [, buffer [, offset]]])Generate and return a RFC4122 v4 UUID.
options - (Object) Optional uuid state to apply. Properties may include:
random - (Number[16]) Array of 16 numbers (0-255) to use in place of randomly generated values
rng - (Function) Random # generator to use. Set to one of the built-in generators - uuid.mathRNG (all platforms), uuid.nodeRNG (node.js only), uuid.whatwgRNG (WebKit only) - or a custom function that returns an array[16] of byte values.
buffer - (Array | Buffer) Array or buffer where UUID bytes are to be written.
offset - (Number) Starting index in buffer at which to begin writing.
Returns buffer, if specified, otherwise the string form of the UUID
Example: Generate string UUID with fully-specified options
.v4({
ndom: [
0x10, 0x91, 0x56, 0xbe, 0xc4, 0xfb, 0xc1, 0xea,
0x71, 0xb4, 0xef, 0xe1, 0x67, 0x1c, 0x58, 0x36
> "109156be-c4fb-41ea-b1b4-efe1671c5836"
Example: Generate two IDs in a single buffer
buffer = new Array(32); // (or 'new Buffer' in node.js)
.v4(null, buffer, 0);
.v4(null, buffer, 16);
Parse and unparse UUIDs
id - (String) UUID(-like) stringbuffer - (Array | Buffer) Array or buffer where UUID bytes are to be written. Default: A new Array or Buffer is usedoffset - (Number) Starting index in buffer at which to begin writing. Default: 0Example parsing and unparsing a UUID string
bytes = uuid.parse('797ff043-11eb-11e1-80d6-510998755d10'); // -> <Buffer 79 7f f0 43 11 eb 11 e1 80 d6 51 09 98 75 5d 10>
string = uuid.unparse(bytes); // -> '797ff043-11eb-11e1-80d6-510998755d10'
(Browsers only) Set uuid property back to it's previous value.
Returns the node-uuid object.
Example:
myUuid = uuid.noConflict();
id.v1(); // -> '6c84fb90-12c4-11e1-840d-7b25c5ee775a'
Support for the following v1.2 APIs is available in v1.3, but is deprecated and will be removed in the next major version.
uuid() has become uuid.v4(), and the format argument is now implicit in the buffer argument. (i.e. if you specify a buffer, the format is assumed to be binary).
The class of container created when generating binary uuid data if no buffer argument is specified. This is expected to go away, with no replacement API.
To use the executable, it's probably best to install this library globally.
npm install -g node-uuid
Usage:
E: uuid [version] [options]
ons:
lp Display this message and exit
version must be an RFC4122 version that is supported by this library, which is currently version 1 and version 4 (denoted by “v1” and “v4”, respectively). version defaults to version 4 when not supplied.
id
f950-dec8-4688-ba14-5b7bbfc7a563
id v1
43e0-7696-11e3-964b-250efa37a98e
id v4
ac7c-24ac-4f98-8464-42f6d98a53ae
In node.js
test
In Browser
test/test.html
Requires node.js
install uuid uuid-js
benchmark/benchmark.js
For a more complete discussion of node-uuid performance, please see the benchmark/README.md file, and the benchmark wiki
For browser performance checkout the JSPerf tests.