itsamatch

Delightful Sum Types in TypeScript

Usage no npm install needed!

<script type="module">
  import itsamatch from 'https://cdn.skypack.dev/itsamatch';
</script>

README

NPM Package Build Size

It's a match!

Itsamatch is a tiny set of types and utilities to define and use variants / tagged unions / sum types in a more declarative way in TypeScript.

Usage

itsamatch exposes two functions and a few types that make it easier to construct data types. Below is a simple example showing how it can be used to create a linked list data type :

import { DataType, genConstructors, match } from 'itsamatch';

// a list is a data type with two variants:
type List<T> = DataType<{
    Nil: {},
    Cons: { head: T, tail: List<T> }
}>;

// generate default variant constructors for lists of numbers
const { Nil, Cons } = genConstructors<List<number>>()('Nil', 'Cons');

// use the match function to compute the length of a list
const len = <T>(list: List<T>): number => match(list, {
    Nil: () => 0,
    Cons: ({ tail }) => 1 + len(tail)
});

// size is 2
const size = len(Cons({ head: 1, tail: Cons({ head: 2, tail: Nil({}) }) }));

More examples are available in the /examples folder