README.md

typesafe-uuid

Library to enable the definition of different types of objects indexed by a uuid

Install

You can add this library to your project using:

npm install typesafe-uuid

or

yarn add typesafe-uuid

Example Usage

import { uuidType } from 'typesafe-uuid';

class AnimalId extends uuidType<'AnimalId'>() {}
class VegtableId extends uuidType<'VegtableId'>() {}

let dog: AnimalId = AnimalId.fromUuid('200a6b06-1120-4970-a0dc-3c48102d46ad');
let carrot : VegtableId = VegtableId.fromUuid('5ec48ef0-181d-454b-9834-a4d2c070b43a');

dog = carrot // type error 

This will error with:

error TS2322: Type 'VegtableId' is not assignable to type 'AnimalId'.
  Types of property ''__ kind'' are incompatible.
    Type '"VegtableId"' is not assignable to type '"AnimalId"'.

see corresponding test