README

minewt

Travis CI badge

A tiny newtype implementation for TypeScript.

Thanks to MayMoonsley for the very punny name :3

Motivation

Type aliases are a very common tool in TypeScript for type abstraction. They make it easy to assign names to more complex types, and can even be used for some degree of type-level programming. However, sometimes, something like the following crops up:

type Dollars = number;

The name Dollars is now an alias for number; now, instead of writing pay(amount: number), we can write pay(amount: Dollars). However, this does not create a new type; it is not a compile error to pass in any old number into pay. At best, it serves as documentation for programmers reading the code, but it doesn't provide any type safety.

Another approach is to take the Java route, and make a new object to wrap numbers:

class Dollars {
    constructor(public readonly amount: number) {}
}

Now, we can convert to and from this new type via the constructor and field:

const dollars: Dollars = new Dollars(3);
const amount: number = dollars.amount;

This has the type safety we want; Dollars is a distinct type from number! Unfortunately, this creates a new object for every Dollars we have, and incurs a boxing penalty. What we really want is to create a type with the same runtime representation as number, but create it as a distinct type, with neither assignable to the other.

A newtype is the best of both worlds. A newtype:

is a distinct type from its underlying type
has the same runtime representation as its underlying type

After compilation, a newtype will be exactly the same as its underlying type; all values of type Dollars will be numbers at runtime. It's safe to cast between the two, since they have exactly the same representation. This makes newtypes a kind of zero-cost abstraction.

Usage

To create the type and the wrapper:

// Create the newtype itself
type Dollars = Newtype<number, { readonly _: unique symbol; }>;

// Create the newtype wrapper function
const Dollars = newtype<Dollars>();

To wrap and unwrap values:

// Wrap underlying type in newtype
const dollars: Dollars = Dollars(3);
// Unwrap newtype into underlying type
const amount: number = unwrap(dollars);

// A newtype creates a distinct type:
const x: Dollars = 3; // Error! Type '3' is not assignable to type 'Dollars'

To query the underlying representation type, use NewtypeRepr:

type T = NewtypeRepr<Dollars>; // 'number'

You can also lift functions over the underlying type to functions over the wrapped type using liftN and liftN2 (higher-arity lifting functions are easy to define if necessary):

function add(x: number, y: number): number {
    return x + y;
}

const x: Dollars = ...;
const y: Dollars = ...;

const addDollars = liftN2<Dollars>(add);

const sum = addDollars(x, y);

It's even possible to make newtypes that are assignable to other newtypes, using intersection types with &:

type A = Newtype<number, { readonly _: unique symbol; }>;
const A = newtype<A>();

// B extends A
type B = Newtype<number, { readonly _: unique symbol; }> & A;
const B = newtype<B>();

const x: A = A(0); // okay
const y: A = B(0); // okay
const z: B = A(0); // compile error: Type 'A' is not assignable to type 'B'

Comparisons and Alternatives

minewt is very lightweight, and doesn't provide any specific newtype implementations.

Other newtype implementations

newtype-ts: uses a similar approach, but heavier weight, as it's tightly integrated with functional optics as part of the fp-ts community

@nprindle/minewt

Usage no npm install needed!