You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 7.7KB

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