UUID String to Buffer Parser

Common errors

• TypeError: uuidParse is not a function

  cause Attempting to call `uuidParse()` directly after `require('uuid-parse')` when it's an object with `parse` and `unparse` methods.
  fix Access the methods as `uuidParse.parse(...)` or `uuidParse.unparse(...)`.

• uuidParse.parse is not a function (in an ES Module context)

  cause Trying to use CommonJS `require`'d module in an ES Module environment without proper interop, or attempting `import uuidParse from 'uuid-parse'` which yields an empty object or `undefined`.
  fix Switch to `require` syntax or, preferably, migrate to a modern, actively maintained UUID library that supports ES Modules, such as `uuid`.

• ReferenceError: Buffer is not defined (in a browser environment)

  cause This package relies on Node.js's global `Buffer` object, which is not available in standard browser environments.
  fix Use a bundler (like Webpack or Rollup) that automatically provides a Buffer polyfill for browser compatibility, or manually include a Buffer polyfill. Alternatively, switch to a UUID library designed for universal (Node.js and browser) usage.

Warnings

• breaking This module is no longer maintained. It will not receive updates for security vulnerabilities, bug fixes, or new features. Projects should migrate to actively maintained alternatives like the `uuid` package for robustness and security.
  Fix: Replace `uuid-parse` with `@lukeed/uuid` (lightweight) or `uuid` (feature-rich). Example: `uuid.parse()` and `uuid.stringify()` for `uuid` package.
• gotcha The package is CommonJS-only (`require`). It does not natively support ES Modules (`import`). Attempting to use `import` syntax will result in errors in pure ESM environments.
  Fix: Ensure your project uses CommonJS if you must use this package, or transpile your code. The recommended fix is to migrate to an ESM-compatible UUID library.
• gotcha Due to its age and abandonment, `uuid-parse` might exhibit unexpected behavior or compatibility issues with newer Node.js Buffer APIs or browser environments if not properly polyfilled or bundled. The `Buffer` object is a Node.js primitive.
  Fix: Test thoroughly in your target environment. For browser usage, ensure a `Buffer` polyfill is in place. For Node.js, consider migrating to avoid potential future incompatibilities.

Install

• npm install uuid-parse npm
• yarn add uuid-parse yarn
• pnpm add uuid-parse pnpm

Imports

• uuidParse
  wrong:

  import uuidParse from 'uuid-parse';

  correct:

  const uuidParse = require('uuid-parse');

  This package is CommonJS-only and explicitly unmaintained. For modern ESM projects, consider the `uuid` package's `parse` and `stringify` functions instead.
• parse
  wrong:

  import { parse } from 'uuid-parse';

  correct:

  const { parse } = require('uuid-parse');

  The `parse` function is a named export available via CommonJS destructuring. Direct ESM named imports are not supported.
• unparse
  wrong:

  import { unparse } from 'uuid-parse';

  correct:

  const { unparse } = require('uuid-parse');

  The `unparse` function is a named export available via CommonJS destructuring. Direct ESM named imports are not supported.

Quickstart

Demonstrates parsing a UUID string into a Buffer and unparsing a Buffer back into a string, including usage with offsets and target buffers.

const uuidParse = require('uuid-parse');

const uuidString = '797ff043-11eb-11e1-80d6-510998755d10';

// Parse a UUID string into a Buffer
const bytes = uuidParse.parse(uuidString);
console.log('Parsed bytes:', bytes.toString('hex'));
// Example with a target buffer and offset
const targetBuffer = Buffer.alloc(32);
const offset = 8;
uuidParse.parse(uuidString, targetBuffer, offset);
console.log('Parsed into target buffer:', targetBuffer.toString('hex'));

// Unparse a Buffer into a UUID string
const string = uuidParse.unparse(bytes);
console.log('Unparsed string:', string);

// Unparsing from a specific offset in a buffer
const unparsedFromOffset = uuidParse.unparse(targetBuffer, offset);
console.log('Unparsed from offset:', unparsedFromOffset);