# uuid-fns

> A glossary of intuitive, universally unambiguous Uuid resources and procedures.

Latest version **1.1.3** (published 2025-12-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install uuid-fns
pnpm add uuid-fns
yarn add uuid-fns
bun add uuid-fns
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2025-12-03 |
| First published | 2025-06-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 2 |
| Unpacked size | 18.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | ehmpathy |
| Maintainers | uladkasach |
| Keywords | uuid |

## Links

- npm: https://www.npmjs.com/package/uuid-fns
- Repository: https://github.com/ehmpathy/uuid-fns
- Issues: https://github.com/ehmpathy/uuid-fns/issues
- npm.io page: https://npm.io/package/uuid-fns

## Dependencies (2)

- [uuid](https://npm.io/package/uuid.md) 11.1.0
- [type-fns](https://npm.io/package/type-fns.md) 1.21.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.1.3 (latest) — 2025-12-03
- 1.1.2 — 2025-12-03
- 1.1.1 — 2025-12-02
- 1.1.0 — 2025-12-02
- 1.0.2 — 2025-07-13
- 1.0.1 — 2025-07-13
- 1.0.0 — 2025-06-23

## README

# uuid-fns

![test](https://github.com/ehmpathy/uuid-fns/workflows/test/badge.svg)
![publish](https://github.com/ehmpathy/uuid-fns/workflows/publish/badge.svg)

A glossary of intuitive, universally unambiguous **uuid** definitions and useful procedures.

Isomorphic - works in both Node.js and browser environments.

# purpose

1. declare an intuitive and stable definition of `Uuid`

2. create a pit of success for uuid utilization

3. declare a ubiquitous language for
    - domain objects related to `uuid`s
      - `Uuid`
    - domain operations related to `uuid`s
      - `isUuid`
      - `getUuid`
      - `getHash`

# install

```sh
npm install uuid-fns
```

# use

### `Uuid`

branded type for compile-time safety

```ts
import { Uuid, isUuid, getUuid } from 'uuid-fns';

// compile-time error: string is not assignable to Uuid
const id: Uuid = '550e8400-e29b-41d4-a716-446655440000'; // error

// use isUuid.assure to validate and cast
const id: Uuid = isUuid.assure('550e8400-e29b-41d4-a716-446655440000'); // ok

// or use getUuid which returns Uuid directly
const id: Uuid = getUuid(); // ok
```

### `isUuid`

type guard to check if a string is a valid uuid

```ts
import { isUuid, Uuid } from 'uuid-fns';

// type guard usage
const maybeUuid = '550e8400-e29b-41d4-a716-446655440000';
if (isUuid(maybeUuid)) {
  // typescript now knows maybeUuid is of type Uuid
}

// check without assertion
isUuid('not-a-uuid'); // false
isUuid('550e8400-e29b-41d4-a716-446655440000'); // true

// runtime assertion - throws if invalid
const validUuid: Uuid = isUuid.assure('550e8400-e29b-41d4-a716-446655440000');
```

### `getUuid`

get a new random uuid v4

```ts
import { getUuid, Uuid } from 'uuid-fns';

const id: Uuid = getUuid();
// e.g., '550e8400-e29b-41d4-a716-446655440000'

// each call returns a unique id
const id1 = getUuid();
const id2 = getUuid();
console.log(id1 === id2); // false
```

### `getHash`

get a deterministic uuid from any string via SHA-1 hash (UUID v5)

```ts
import { getHash, isUuid } from 'uuid-fns';

// same input always returns the same uuid
const hash1 = getHash('hello');
const hash2 = getHash('hello');
console.log(hash1 === hash2); // true

// different inputs return different uuids
const hashA = getHash('hello');
const hashB = getHash('world');
console.log(hashA === hashB); // false

// use a custom namespace for isolation
const myNamespace = isUuid.assure('6ba7b810-9dad-11d1-80b4-00c04fd430c8');
const scopedHash = getHash('hello', { namespace: myNamespace });
```

---
_Source: https://npm.io/package/uuid-fns · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._