Typect

Documentation is currently being written.
The API may change during development as it is still actively being developed.

Typect is Type-Level Testing Framework based HKT (Higher Kinded Type).
I believe the TypeScript compiler is the best test runner. (Just kidding)

Typect means "type" + "expect".

Install

npm add --save-dev typect

yarn add -D typect

pnpm add -D typect

Example

Load the full matchers

// Load the full matchers
import { Expect, _ } from "typect"

// Load specific matchers
import { 
  Expect,
  ToBeLessThan,
  Not,
  Returns,
} from "typect"

// with specific matchers
Expect<1, ToBeLessThan<2>>
Expect<{ a: 1 }, Not.ToMatch<{ b: 1 }>>
Expect<() => 1, Returns.ToEqual<1>>

// with full matchers
Expect<1, _.ToBeDefined>
Expect<1, _.ToBeLessThan<2>>
Expect<[1, 2, 3], _.ToHaveLength<3>>
Expect<{ a: 1 }, _.ToHaveProperty<"a">>
Expect<{ a: 1 }, _.Not.ToMatch<{ b: 1 }>>
Expect<() => 1, _.Returns.ToEqual<1>>

type GuardFn = (input: any) => input is { a: 1 }
Expect<GuardFn, _.Guards.ToEqual<{ a: 1 }>>

type PromiseValue = Promise<1>
Expect<PromiseValue, _.Resolves.ToEqual<1>>