@ezmockup/ezuuid
Version:
A simple and easy-to-use UUID generation and processing library.
51 lines (39 loc) • 1.49 kB
Markdown
# ezuuid
A simple, lightweight UUID utility library for TypeScript/JavaScript. Supports UUID v1, v3, v4, v5 generation, validation, and formatting. **Node.js only.**
## Features
- Generate UUIDs (v1, v3, v4, v5)
- Validate UUID format
- Format UUID strings
- Min/Max UUID constants
- Node.js compatible
## Installation
```sh
npm install ezuuid
```
## Usage
```ts
import { V1, V3, V4, V5, validateUUID, formatUUID, Min, Max } from 'ezuuid';
const uuid1 = V1();
const uuid3 = V3('name', 'namespace-uuid');
const uuid4 = V4();
const uuid5 = V5('name', 'namespace-uuid');
console.log(validateUUID(uuid4)); // true
console.log(formatUUID(' 123E4567-E89B-12D3-A456-426614174000 ')); // '123e4567-e89b-12d3-a456-426614174000'
console.log(Min, Max);
```
## API
### UUID Generation
- `V1(): string` — Generate a UUID v1 (timestamp-based)
- `V3(name: string, namespace: string): string` — Generate a UUID v3 (namespace + name, MD5)
- `V4(): string` — Generate a UUID v4 (random)
- `V5(name: string, namespace: string): string` — Generate a UUID v5 (namespace + name, SHA1)
### Validation & Formatting
- `validateUUID(uuid: string): boolean` — Validate if a string is a valid UUID v4
- `formatUUID(uuid: string): string` — Trim and lowercase a UUID string
### Constants
- `Min` — The minimum UUID value (all zeros)
- `Max` — The maximum UUID value (all fs)
## Environment
This library is for **Node.js only**.
## License
MIT