iansan5653 / assertion-types Goto Github PK

assertion-types is a tiny, fast, and, easy-to-learn type-testing library that requires no extra build/test setup.

The assertion-types library provides four simple tests for inspecting types: Equals, Extends, NotEquals, and NotExtends. Along with the included Assert type, these utilities allow you to test that the results of your types are what you expect them to be. Because this method requires no other tools besides the TypeScript compiler, errors will show up right in your editor and you won't be able to build your project if your tests fail.

Usage is simple:

import {Assert, Equals, Extends, NotEquals, NotExtends} from "assertion-types";

// Equals:
type EqualsExample = Assert<Equals<123, 123>>;

// NotEquals:
type NotEqualsExample = Assert<NotEquals<123, 456>>;

// Extends:
type ExtendsExample = Assert<Extends<123, number>>;

// NotExtends:
type NotExtendsExample = Assert<NotExtends<number, 123>>;

Install via NPM:

npm install --save-dev assertion-types

After that, just import into your test files:

import * as assertionTypes from "assertion-types";
// OR
import {Assert, Equals, Extends, NotEquals, NotExtends} from "assertion-types";

No need to run any commands to run the tests - if they error, they will error when the TypeScript compiler runs.

Any sufficiently complex TypeScript project will eventually require the development of utility types, which are often left untested because unit tests cannot be written for types. However, testing these types ensures that your type system is sound and therefore you can rely on type errors to prevent the cases that you assume cannot happen based on your understanding of your types.

The standard alternative for this is dtslint, which uses $ExpectType comments to test types with an external tool. However, this requires an additional testing step rather than just taking advantage of the compiler's abilities. A failed $ExpectType will only error when someone runs the dtslint command, while an error with these utilities will never make it past tsc.