uuid

The uuid library supports the following environments:

• Browsers: Tested against the latest versions of desktop Chrome, Safari, Firefox, and Edge. Mobile versions of these browsers are expected to work but are not explicitly tested.
• Node.js: Supports current LTS releases and the release immediately prior (e.g., node@20 through node@24).
• TypeScript: Supports TypeScript versions released within the past two years.

To generate a random (version 4) UUID, import the v4 function from the uuid package and call it. This is the most common way to generate unique identifiers.

import { v4 as uuidv4 } from 'uuid';

uuidv4(); // ⇨ 'b18794e8-5d0d-417c-b361-ba38e78411b4'

To run the browser-based demonstration of uuid using Rollup.js, follow these steps:

1. Install dependencies using npm.
2. Start the development server.
3. Open the generated example-*.html files in your browser.

This example demonstrates how uuid works in a browser environment and shows that tree-shaking effectively reduces bundle size when only specific UUID versions are imported.

npm install
npm start

To run the performance benchmarks in a web browser, use the start script and view the results in the browser's developer console.

```bash
npm install
npm run start

After running the command, open benchmark.html in your browser and check the console for the output.

To set up and run the uuid example project using Node.js and Webpack, follow these steps:

1. Install dependencies using npm install.
2. Run the tests and build process using npm test.

After running these commands, Webpack will generate bundles located in the ./dist directory, which are then executed.

To run the browser-based demonstration of uuid using Webpack, follow these steps in your terminal:

1. Install dependencies using npm install.
2. Start the development server using npm start.
3. Open the generated example-*.html files in your browser to view the results.

This example demonstrates how uuid can be bundled for the browser and shows that tree-shaking works as expected, allowing you to only include the specific UUID versions you need (e.g., v1.js or v4.js) in your final bundle.

To run the browser-based demonstration of uuid using native ECMAScript Modules, follow these steps:

1. Install dependencies using npm.
2. Start the local development server.
3. Open example.html in your browser to view the running example.

npm install
npm start

Install the uuid package using npm to start generating RFC9562 compliant UUIDs in your project.

npm install uuid

To set up and run the Node.js ESModules example project, use the following commands to install dependencies and execute the test suite:

npm install
npm test

To run the example project using Node.js and the Jest testing framework, follow these steps:

1. Install the project dependencies using npm.
2. Execute the tests using npm test to verify the implementation.

npm install
npm test

To execute the performance benchmarks for the uuid library in a Node.js environment, first install the dependencies and then run the test command.

npm install
npm test

The UUIDTypes type represents the possible output formats for UUID generation functions. A UUID can be returned as either a standard string or as a Uint8Array (or a specific subclass of Uint8Array). This allows developers to choose between human-readable strings or high-performance byte buffers.

// A UUID can be a string or a Uint8Array
type UUIDTypes<TBuf extends Uint8Array = Uint8Array> = string | TBuf;