Skip to main content
Version: 3.0.0-dev 🔨

Variant Build Status npm NPM

A variant type is like an enum but each case can hold some extra data.

bash
npm i -S variant
bash
npm i -S variant

Variant aims to bring the experience of variant types to TypeScript. Variant types, a.k.a. discriminated unions in the TypeScript world, are an excellent tool for describing and handling flexible domain models and tiny DSLs. However, because "TypeScript instead builds on JavaScript patterns as they exist today" using them as-is can result in tedious and fragile code. This project addresses that by providing well-typed, fluent, and expressive tools to safely do away with the boilerplate.

Documentation

everything below this line is project documentation for developers. Please use the website linked just above.


Initial setup

bash
npm install
bash
npm install

build

bash
npm run build
bash
npm run build

test

bash
npm test
bash
npm test

Questions, comments, and contributions are welcome. Open an issue.