@japa/expect-type

Write assertions for TypeScript types

The expect-type plugin of Japa helps you write assertions against the TypeScript types. There is no runtime behavior with the expect-type plugin and you need to compile your code to view the assertion errors.

The plugins wraps expect-type under the hood.

Complete API documentation

Installation

Install the package from the npm registry as follows:

npm i @japa/expect-type

yarn add @japa/expect-type

Usage

You can use this package with the @japa/runner as follows.

import { expectTypeOf } from '@japa/expect-type'
import { configure } from '@japa/runner'

configure({
  plugins: [expectTypeOf()],
})

Once done, you will be able to access the expectTypeOf property on the test context.

test('test title', ({ expectTypeOf }) => {
  expectTypeOf({ foo: 'bar' }).toEqualTypeOf<{ foo: string }>()
})