index overview

Added in v0.1.0

---

Table of contents

• constructors
  • Uuid
  • v4
• model
  • Uuid (type alias)
• refinements
  • isUuid

---

constructors

Uuid

Signature

export declare function Uuid(uuid: string): Uuid

Example

import { Uuid } from 'uuid-ts'

const uuid = Uuid('224d8877-d59f-409f-aed0-5157df78357f')

assert.deepStrictEqual(uuid, '224d8877-d59f-409f-aed0-5157df78357f')

Added in v0.1.1

v4

Signature

export declare function v4(): IO<Uuid<4>>

Added in v0.1.0

model

Uuid (type alias)

Signature

export type Uuid<V extends UuidVersion = UuidVersion> = string & UuidBrand<V>

Added in v0.1.0

refinements

isUuid

Signature

export declare const isUuid: Refinement<unknown, Uuid<UuidVersion>>

Added in v0.1.0