\hypertarget{md_sfcode_node_modules_uuid_README_autotoc_md31740}{}\doxysection{uuid $<$a href=\char`\"{}http\+://travis-\/ci.\+org/kelektiv/node-\/uuid\char`\"{}$>$$<$img src=\char`\"{}https\+://secure.\+travis-\/ci.\+org/kelektiv/node-\/uuid.\+svg?branch=master\char`\"{} alt=\char`\"{}\+Build Status\char`\"{}/$>$$<$/a$>$}\label{md_sfcode_node_modules_uuid_README_autotoc_md31740}
Simple, fast generation of \href{http://www.ietf.org/rfc/rfc4122.txt}{\texttt{ RFC4122}} UUIDS.

Features\+:


\begin{DoxyItemize}
\item Support for version 1, 3, 4 and 5 UUIDs
\item Cross-\/platform
\item Uses cryptographically-\/strong random number APIs (when available)
\item Zero-\/dependency, small footprint (... but not \href{https://gist.github.com/982883}{\texttt{ this small}})
\end{DoxyItemize}

\mbox{[}{\bfseries{Deprecation warning}}\+: The use of `require(\textquotesingle{}uuid'){\ttfamily is deprecated and will not be supported after version 3.\+x of this module. Instead, use}require(\textquotesingle{}uuid/\mbox{[}v1$\vert$v3$\vert$v4$\vert$v5\mbox{]}\textquotesingle{})\`{} as shown in the examples below.\mbox{]}\hypertarget{md_sfcode_node_modules_uuid_README_autotoc_md31741}{}\doxysubsection{Quickstart -\/ Common\+JS (\+Recommended)}\label{md_sfcode_node_modules_uuid_README_autotoc_md31741}

\begin{DoxyCode}{0}
\DoxyCodeLine{npm install uuid }

\end{DoxyCode}


Then generate your uuid version of choice ...

Version 1 (timestamp)\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{const uuidv1 = require('uuid/v1');}
\DoxyCodeLine{uuidv1(); // ⇨ '2c5ea4c0-\/4067-\/11e9-\/8bad-\/9b1deb4d3b7d'}

\end{DoxyCode}


Version 3 (namespace)\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{const uuidv3 = require('uuid/v3');}
\DoxyCodeLine{}
\DoxyCodeLine{// ... using predefined DNS namespace (for domain names)}
\DoxyCodeLine{uuidv3('hello.example.com', uuidv3.DNS); // ⇨ '9125a8dc-\/52ee-\/365b-\/a5aa-\/81b0b3681cf6'}
\DoxyCodeLine{}
\DoxyCodeLine{// ... using predefined URL namespace (for, well, URLs)}
\DoxyCodeLine{uuidv3('http://example.com/hello', uuidv3.URL); // ⇨ 'c6235813-\/3ba4-\/3801-\/ae84-\/e0a6ebb7d138'}
\DoxyCodeLine{}
\DoxyCodeLine{// ... using a custom namespace}
\DoxyCodeLine{//}
\DoxyCodeLine{// Note: Custom namespaces should be a UUID string specific to your application!}
\DoxyCodeLine{// E.g. the one here was generated using this modules `uuid` CLI.}
\DoxyCodeLine{const MY\_NAMESPACE = '1b671a64-\/40d5-\/491e-\/99b0-\/da01ff1f3341';}
\DoxyCodeLine{uuidv3('Hello, World!', MY\_NAMESPACE); // ⇨ 'e8b5a51d-\/11c8-\/3310-\/a6ab-\/367563f20686'}

\end{DoxyCode}


Version 4 (random)\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{const uuidv4 = require('uuid/v4');}
\DoxyCodeLine{uuidv4(); // ⇨ '1b9d6bcd-\/bbfd-\/4b2d-\/9b5d-\/ab8dfbbd4bed'}

\end{DoxyCode}


Version 5 (namespace)\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{const uuidv5 = require('uuid/v5');}
\DoxyCodeLine{}
\DoxyCodeLine{// ... using predefined DNS namespace (for domain names)}
\DoxyCodeLine{uuidv5('hello.example.com', uuidv5.DNS); // ⇨ 'fdda765f-\/fc57-\/5604-\/a269-\/52a7df8164ec'}
\DoxyCodeLine{}
\DoxyCodeLine{// ... using predefined URL namespace (for, well, URLs)}
\DoxyCodeLine{uuidv5('http://example.com/hello', uuidv5.URL); // ⇨ '3bbcee75-\/cecc-\/5b56-\/8031-\/b6641c1ed1f1'}
\DoxyCodeLine{}
\DoxyCodeLine{// ... using a custom namespace}
\DoxyCodeLine{//}
\DoxyCodeLine{// Note: Custom namespaces should be a UUID string specific to your application!}
\DoxyCodeLine{// E.g. the one here was generated using this modules `uuid` CLI.}
\DoxyCodeLine{const MY\_NAMESPACE = '1b671a64-\/40d5-\/491e-\/99b0-\/da01ff1f3341';}
\DoxyCodeLine{uuidv5('Hello, World!', MY\_NAMESPACE); // ⇨ '630eb68f-\/e0fa-\/5ecc-\/887a-\/7c7a62614681'}

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_uuid_README_autotoc_md31742}{}\doxysubsection{API}\label{md_sfcode_node_modules_uuid_README_autotoc_md31742}
\hypertarget{md_sfcode_node_modules_uuid_README_autotoc_md31743}{}\doxysubsubsection{Version 1}\label{md_sfcode_node_modules_uuid_README_autotoc_md31743}

\begin{DoxyCode}{0}
\DoxyCodeLine{const uuidv1 = require('uuid/v1');}
\DoxyCodeLine{}
\DoxyCodeLine{// Incantations}
\DoxyCodeLine{uuidv1();}
\DoxyCodeLine{uuidv1(options);}
\DoxyCodeLine{uuidv1(options, buffer, offset); }

\end{DoxyCode}


Generate and return a RFC4122 v1 (timestamp-\/based) UUID.


\begin{DoxyItemize}
\item {\ttfamily options} -\/ (Object) Optional uuid state to apply. Properties may include\+:
\begin{DoxyItemize}
\item {\ttfamily node} -\/ (Array) Node id as Array of 6 bytes (per 4.\+1.\+6). Default\+: Randomly generated ID. See note 1.
\item {\ttfamily clockseq} -\/ (Number between 0 -\/ 0x3fff) RFC clock sequence. Default\+: An internally maintained clockseq is used.
\item {\ttfamily msecs} -\/ (Number) Time in milliseconds since unix Epoch. Default\+: The current time is used.
\item {\ttfamily nsecs} -\/ (Number between 0-\/9999) additional time, in 100-\/nanosecond units. Ignored if {\ttfamily msecs} is unspecified. Default\+: internal uuid counter is used, as per 4.\+2.\+1.\+2.
\end{DoxyItemize}
\item {\ttfamily buffer} -\/ (Array $\vert$ Buffer) Array or buffer where UUID bytes are to be written.
\item {\ttfamily offset} -\/ (Number) Starting index in {\ttfamily buffer} at which to begin writing.
\end{DoxyItemize}

Returns {\ttfamily buffer}, if specified, otherwise the string form of the UUID

Note\+: The default \href{https://tools.ietf.org/html/rfc4122\#section-4.1.6}{\texttt{ node id}} (the last 12 digits in the UUID) is generated once, randomly, on process startup, and then remains unchanged for the duration of the process.

Example\+: Generate string UUID with fully-\/specified options


\begin{DoxyCode}{0}
\DoxyCodeLine{const v1options = \{}
\DoxyCodeLine{  node: [0x01, 0x23, 0x45, 0x67, 0x89, 0xab],}
\DoxyCodeLine{  clockseq: 0x1234,}
\DoxyCodeLine{  msecs: new Date('2011-\/11-\/01').getTime(),}
\DoxyCodeLine{  nsecs: 5678}
\DoxyCodeLine{\};}
\DoxyCodeLine{uuidv1(v1options); // ⇨ '710b962e-\/041c-\/11e1-\/9234-\/0123456789ab'}

\end{DoxyCode}


Example\+: In-\/place generation of two binary IDs


\begin{DoxyCode}{0}
\DoxyCodeLine{// Generate two ids in an array}
\DoxyCodeLine{const arr = new Array();}
\DoxyCodeLine{uuidv1(null, arr, 0);  // ⇨ }
\DoxyCodeLine{  // [}
\DoxyCodeLine{  //    44,  94, 164, 192,  64, 103,}
\DoxyCodeLine{  //    17, 233, 146,  52, 155,  29,}
\DoxyCodeLine{  //   235,  77,  59, 125}
\DoxyCodeLine{  // ]}
\DoxyCodeLine{uuidv1(null, arr, 16); // ⇨ }
\DoxyCodeLine{  // [}
\DoxyCodeLine{  //    44, 94, 164, 192,  64, 103, 17, 233,}
\DoxyCodeLine{  //   146, 52, 155,  29, 235,  77, 59, 125,}
\DoxyCodeLine{  //    44, 94, 164, 193,  64, 103, 17, 233,}
\DoxyCodeLine{  //   146, 52, 155,  29, 235,  77, 59, 125}
\DoxyCodeLine{  // ]}

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_uuid_README_autotoc_md31744}{}\doxysubsubsection{Version 3}\label{md_sfcode_node_modules_uuid_README_autotoc_md31744}

\begin{DoxyCode}{0}
\DoxyCodeLine{const uuidv3 = require('uuid/v3');}
\DoxyCodeLine{}
\DoxyCodeLine{// Incantations}
\DoxyCodeLine{uuidv3(name, namespace);}
\DoxyCodeLine{uuidv3(name, namespace, buffer);}
\DoxyCodeLine{uuidv3(name, namespace, buffer, offset); }

\end{DoxyCode}


Generate and return a RFC4122 v3 UUID.


\begin{DoxyItemize}
\item {\ttfamily name} -\/ (String $\vert$ Array\mbox{[}\mbox{]}) \char`\"{}name\char`\"{} to create UUID with
\item {\ttfamily namespace} -\/ (String $\vert$ Array\mbox{[}\mbox{]}) \char`\"{}namespace\char`\"{} UUID either as a String or Array\mbox{[}16\mbox{]} of byte values
\item {\ttfamily buffer} -\/ (Array $\vert$ Buffer) Array or buffer where UUID bytes are to be written.
\item {\ttfamily offset} -\/ (Number) Starting index in {\ttfamily buffer} at which to begin writing. Default = 0
\end{DoxyItemize}

Returns {\ttfamily buffer}, if specified, otherwise the string form of the UUID

Example\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{uuidv3('hello world', MY\_NAMESPACE);  // ⇨ '042ffd34-\/d989-\/321c-\/ad06-\/f60826172424'}

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_uuid_README_autotoc_md31745}{}\doxysubsubsection{Version 4}\label{md_sfcode_node_modules_uuid_README_autotoc_md31745}

\begin{DoxyCode}{0}
\DoxyCodeLine{const uuidv4 = require('uuid/v4')}
\DoxyCodeLine{}
\DoxyCodeLine{// Incantations}
\DoxyCodeLine{uuidv4();}
\DoxyCodeLine{uuidv4(options);}
\DoxyCodeLine{uuidv4(options, buffer, offset); }

\end{DoxyCode}


Generate and return a RFC4122 v4 UUID.


\begin{DoxyItemize}
\item {\ttfamily options} -\/ (Object) Optional uuid state to apply. Properties may include\+:
\begin{DoxyItemize}
\item {\ttfamily random} -\/ (Number\mbox{[}16\mbox{]}) Array of 16 numbers (0-\/255) to use in place of randomly generated values
\item {\ttfamily rng} -\/ (Function) Random \# generator function that returns an Array\mbox{[}16\mbox{]} of byte values (0-\/255)
\end{DoxyItemize}
\item {\ttfamily buffer} -\/ (Array $\vert$ Buffer) Array or buffer where UUID bytes are to be written.
\item {\ttfamily offset} -\/ (Number) Starting index in {\ttfamily buffer} at which to begin writing.
\end{DoxyItemize}

Returns {\ttfamily buffer}, if specified, otherwise the string form of the UUID

Example\+: Generate string UUID with predefined {\ttfamily random} values


\begin{DoxyCode}{0}
\DoxyCodeLine{const v4options = \{}
\DoxyCodeLine{  random: [}
\DoxyCodeLine{    0x10, 0x91, 0x56, 0xbe, 0xc4, 0xfb, 0xc1, 0xea,}
\DoxyCodeLine{    0x71, 0xb4, 0xef, 0xe1, 0x67, 0x1c, 0x58, 0x36}
\DoxyCodeLine{  ]}
\DoxyCodeLine{\};}
\DoxyCodeLine{uuidv4(v4options); // ⇨ '109156be-\/c4fb-\/41ea-\/b1b4-\/efe1671c5836'}

\end{DoxyCode}


Example\+: Generate two IDs in a single buffer


\begin{DoxyCode}{0}
\DoxyCodeLine{const buffer = new Array();}
\DoxyCodeLine{uuidv4(null, buffer, 0);  // ⇨ }
\DoxyCodeLine{  // [}
\DoxyCodeLine{  //   155, 29, 235,  77,  59,}
\DoxyCodeLine{  //   125, 75, 173, 155, 221,}
\DoxyCodeLine{  //    43, 13, 123,  61, 203,}
\DoxyCodeLine{  //   109}
\DoxyCodeLine{  // ]}
\DoxyCodeLine{uuidv4(null, buffer, 16); // ⇨ }
\DoxyCodeLine{  // [}
\DoxyCodeLine{  //   155,  29, 235,  77,  59, 125,  75, 173,}
\DoxyCodeLine{  //   155, 221,  43,  13, 123,  61, 203, 109,}
\DoxyCodeLine{  //    27, 157, 107, 205, 187, 253,  75,  45,}
\DoxyCodeLine{  //   155,  93, 171, 141, 251, 189,  75, 237}
\DoxyCodeLine{  // ]}

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_uuid_README_autotoc_md31746}{}\doxysubsubsection{Version 5}\label{md_sfcode_node_modules_uuid_README_autotoc_md31746}

\begin{DoxyCode}{0}
\DoxyCodeLine{const uuidv5 = require('uuid/v5');}
\DoxyCodeLine{}
\DoxyCodeLine{// Incantations}
\DoxyCodeLine{uuidv5(name, namespace);}
\DoxyCodeLine{uuidv5(name, namespace, buffer);}
\DoxyCodeLine{uuidv5(name, namespace, buffer, offset); }

\end{DoxyCode}


Generate and return a RFC4122 v5 UUID.


\begin{DoxyItemize}
\item {\ttfamily name} -\/ (String $\vert$ Array\mbox{[}\mbox{]}) \char`\"{}name\char`\"{} to create UUID with
\item {\ttfamily namespace} -\/ (String $\vert$ Array\mbox{[}\mbox{]}) \char`\"{}namespace\char`\"{} UUID either as a String or Array\mbox{[}16\mbox{]} of byte values
\item {\ttfamily buffer} -\/ (Array $\vert$ Buffer) Array or buffer where UUID bytes are to be written.
\item {\ttfamily offset} -\/ (Number) Starting index in {\ttfamily buffer} at which to begin writing. Default = 0
\end{DoxyItemize}

Returns {\ttfamily buffer}, if specified, otherwise the string form of the UUID

Example\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{uuidv5('hello world', MY\_NAMESPACE);  // ⇨ '9f282611-\/e0fd-\/5650-\/8953-\/89c8e342da0b'}

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_uuid_README_autotoc_md31747}{}\doxysubsection{Command Line}\label{md_sfcode_node_modules_uuid_README_autotoc_md31747}
UUIDs can be generated from the command line with the {\ttfamily uuid} command.


\begin{DoxyCode}{0}
\DoxyCodeLine{\$ uuid}
\DoxyCodeLine{ddeb27fb-\/d9a0-\/4624-\/be4d-\/4615062daed4}
\DoxyCodeLine{}
\DoxyCodeLine{\$ uuid v1}
\DoxyCodeLine{02d37060-\/d446-\/11e7-\/a9fa-\/7bdae751ebe1 }

\end{DoxyCode}


Type {\ttfamily uuid -\/-\/help} for usage details\hypertarget{md_sfcode_node_modules_uuid_README_autotoc_md31748}{}\doxysubsection{Testing}\label{md_sfcode_node_modules_uuid_README_autotoc_md31748}

\begin{DoxyCode}{0}
\DoxyCodeLine{npm test }

\end{DoxyCode}


\DoxyHorRuler{0}
 Markdown generated from README\+\_\+js.md by \href{https://github.com/broofa/runmd}{\texttt{ }} 