www.aleph1.co.uk Git - yaffs-website/blob - node_modules/node-uuid/README.md

   1 # node-uuid
   2
   3 Simple, fast generation of [RFC4122](http://www.ietf.org/rfc/rfc4122.txt) UUIDS.
   4
   5 Features:
   6
   7 * Generate RFC4122 version 1 or version 4 UUIDs
   8 * Runs in node.js and all browsers.
   9 * Registered as a [ComponentJS](https://github.com/component/component) [component](https://github.com/component/component/wiki/Components) ('broofa/node-uuid').
  10 * Cryptographically strong random # generation
  11   * `crypto.randomBytes(n)` in node.js
  12   * `window.crypto.getRandomValues(ta)` in [supported browsers](https://developer.mozilla.org/en-US/docs/Web/API/RandomSource/getRandomValues#Browser_Compatibility)
  13 * 1.1K minified and gzip'ed  (Want something smaller?  Check this [crazy shit](https://gist.github.com/982883) out! )
  14 * [Annotated source code](http://broofa.github.com/node-uuid/docs/uuid.html)
  15 * Comes with a Command Line Interface for generating uuids on the command line
  16
  17 ## Getting Started
  18
  19 Install it in your browser:
  20
  21 ```html
  22 <script src="uuid.js"></script>
  23 ```
  24
  25 Or in node.js:
  26
  27 ```
  28 npm install node-uuid
  29 ```
  30
  31 ```javascript
  32 var uuid = require('node-uuid');
  33 ```
  34
  35 Then create some ids ...
  36
  37 ```javascript
  38 // Generate a v1 (time-based) id
  39 uuid.v1(); // -> '6c84fb90-12c4-11e1-840d-7b25c5ee775a'
  40
  41 // Generate a v4 (random) id
  42 uuid.v4(); // -> '110ec58a-a0f2-4ac4-8393-c866d813b8d1'
  43 ```
  44
  45 ## API
  46
  47 ### uuid.v1([`options` [, `buffer` [, `offset`]]])
  48
  49 Generate and return a RFC4122 v1 (timestamp-based) UUID.
  50
  51 * `options` - (Object) Optional uuid state to apply. Properties may include:
  52
  53   * `node` - (Array) Node id as Array of 6 bytes (per 4.1.6). Default: Randomly generated ID.  See note 1.
  54   * `clockseq` - (Number between 0 - 0x3fff) RFC clock sequence.  Default: An internally maintained clockseq is used.
  55   * `msecs` - (Number | Date) Time in milliseconds since unix Epoch.  Default: The current time is used.
  56   * `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.
  57
  58 * `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written.
  59 * `offset` - (Number) Starting index in `buffer` at which to begin writing.
  60
  61 Returns `buffer`, if specified, otherwise the string form of the UUID
  62
  63 Notes:
  64
  65 1. The randomly generated node id is only guaranteed to stay constant for the lifetime of the current JS runtime. (Future versions of this module may use persistent storage mechanisms to extend this guarantee.)
  66
  67 Example: Generate string UUID with fully-specified options
  68
  69 ```javascript
  70 uuid.v1({
  71   node: [0x01, 0x23, 0x45, 0x67, 0x89, 0xab],
  72   clockseq: 0x1234,
  73   msecs: new Date('2011-11-01').getTime(),
  74   nsecs: 5678
  75 });   // -> "710b962e-041c-11e1-9234-0123456789ab"
  76 ```
  77
  78 Example: In-place generation of two binary IDs
  79
  80 ```javascript
  81 // Generate two ids in an array
  82 var arr = new Array(32); // -> []
  83 uuid.v1(null, arr, 0);   // -> [02 a2 ce 90 14 32 11 e1 85 58 0b 48 8e 4f c1 15]
  84 uuid.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]
  85
  86 // Optionally use uuid.unparse() to get stringify the ids
  87 uuid.unparse(buffer);    // -> '02a2ce90-1432-11e1-8558-0b488e4fc115'
  88 uuid.unparse(buffer, 16) // -> '02a31cb0-1432-11e1-8558-0b488e4fc115'
  89 ```
  90
  91 ### uuid.v4([`options` [, `buffer` [, `offset`]]])
  92
  93 Generate and return a RFC4122 v4 UUID.
  94
  95 * `options` - (Object) Optional uuid state to apply. Properties may include:
  96
  97   * `random` - (Number[16]) Array of 16 numbers (0-255) to use in place of randomly generated values
  98   * `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.
  99
 100 * `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written.
 101 * `offset` - (Number) Starting index in `buffer` at which to begin writing.
 102
 103 Returns `buffer`, if specified, otherwise the string form of the UUID
 104
 105 Example: Generate string UUID with fully-specified options
 106
 107 ```javascript
 108 uuid.v4({
 109   random: [
 110     0x10, 0x91, 0x56, 0xbe, 0xc4, 0xfb, 0xc1, 0xea,
 111     0x71, 0xb4, 0xef, 0xe1, 0x67, 0x1c, 0x58, 0x36
 112   ]
 113 });
 114 // -> "109156be-c4fb-41ea-b1b4-efe1671c5836"
 115 ```
 116
 117 Example: Generate two IDs in a single buffer
 118
 119 ```javascript
 120 var buffer = new Array(32); // (or 'new Buffer' in node.js)
 121 uuid.v4(null, buffer, 0);
 122 uuid.v4(null, buffer, 16);
 123 ```
 124
 125 ### uuid.parse(id[, buffer[, offset]])
 126 ### uuid.unparse(buffer[, offset])
 127
 128 Parse and unparse UUIDs
 129
 130   * `id` - (String) UUID(-like) string
 131   * `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written. Default: A new Array or Buffer is used
 132   * `offset` - (Number) Starting index in `buffer` at which to begin writing. Default: 0
 133
 134 Example parsing and unparsing a UUID string
 135
 136 ```javascript
 137 var 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>
 138 var string = uuid.unparse(bytes); // -> '797ff043-11eb-11e1-80d6-510998755d10'
 139 ```
 140
 141 ### uuid.noConflict()
 142
 143 (Browsers only) Set `uuid` property back to it's previous value.
 144
 145 Returns the node-uuid object.
 146
 147 Example:
 148
 149 ```javascript
 150 var myUuid = uuid.noConflict();
 151 myUuid.v1(); // -> '6c84fb90-12c4-11e1-840d-7b25c5ee775a'
 152 ```
 153
 154 ## Deprecated APIs
 155
 156 Support for the following v1.2 APIs is available in v1.3, but is deprecated and will be removed in the next major version.
 157
 158 ### uuid([format [, buffer [, offset]]])
 159
 160 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).
 161
 162 ### uuid.BufferClass
 163
 164 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.
 165
 166 ## Command Line Interface
 167
 168 To use the executable, it's probably best to install this library globally.
 169
 170 `npm install -g node-uuid`
 171
 172 Usage:
 173
 174 ```
 175 USAGE: uuid [version] [options]
 176
 177
 178 options:
 179
 180 --help                     Display this message and exit
 181 ```
 182
 183 `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.
 184
 185 ### Examples
 186
 187 ```
 188 > uuid
 189 3a91f950-dec8-4688-ba14-5b7bbfc7a563
 190 ```
 191
 192 ```
 193 > uuid v1
 194 9d0b43e0-7696-11e3-964b-250efa37a98e
 195 ```
 196
 197 ```
 198 > uuid v4
 199 6790ac7c-24ac-4f98-8464-42f6d98a53ae
 200 ```
 201
 202 ## Testing
 203
 204 In node.js
 205
 206 ```
 207 npm test
 208 ```
 209
 210 In Browser
 211
 212 ```
 213 open test/test.html
 214 ```
 215
 216 ### Benchmarking
 217
 218 Requires node.js
 219
 220 ```
 221 npm install uuid uuid-js
 222 node benchmark/benchmark.js
 223 ```
 224
 225 For a more complete discussion of node-uuid performance, please see the `benchmark/README.md` file, and the [benchmark wiki](https://github.com/broofa/node-uuid/wiki/Benchmark)
 226
 227 For browser performance [checkout the JSPerf tests](http://jsperf.com/node-uuid-performance).
 228
 229 ## Release notes
 230
 231 ### 1.4.6
 232
 233 * Properly detect node crypto and whatwg crypto
 234 * Workaround phantomjs/browserify bug
 235 * Explicit check for `window` rather implicit this-global
 236 * Issue warning if Math.random() is being used
 237 * "use strict";
 238 * A few jshint / stylistic updates (=== and such)
 239
 240 ### 1.4.0
 241
 242 * Improved module context detection
 243 * Removed public RNG functions
 244
 245 ### 1.3.2
 246
 247 * Improve tests and handling of v1() options (Issue #24)
 248 * Expose RNG option to allow for perf testing with different generators
 249
 250 ### 1.3.0
 251
 252 * Support for version 1 ids, thanks to [@ctavan](https://github.com/ctavan)!
 253 * Support for node.js crypto API
 254 * De-emphasizing performance in favor of a) cryptographic quality PRNGs where available and b) more manageable code