UUID overview

Added in v1.0.0

---

Table of contents

• Model
  • UUID (interface)
  • UUIDVersion (type alias)
• String
  • UUID
• utils
  • isoUUID

---

Model

UUID (interface)

Represents strings that are UUIDs.

Signature

export interface UUID<Version extends UUIDVersion> extends Nt.Newtype<UUIDBrand<Version>, string> {}

Added in v1.0.0

UUIDVersion (type alias)

Signature

export type UUIDVersion = keyof typeof uuidPattern

Added in v1.0.0

String

UUID

Signature

export declare const UUID: <Version extends 2 | 1 | 3 | 4 | 5 | 'any'>(
  version: Version
) => Schema<string, UUID<Version>>

Added in v1.0.0

utils

isoUUID

A newtype iso for UUID

Signature

export declare const isoUUID: <Version extends 2 | 1 | 3 | 4 | 5 | 'any'>() => Nt.NewtypeIso<UUID<Version>, string>

Added in v2.0.0