expect-type

Compile-time tests for types. Useful to make sure types don't regress into ...

TestingTypes
mmkal/expect-typeexpect-type

README

expect-type


Compile-time tests for types. Useful to make sure types don't regress into being overly-permissive as changes go in over time.

Similar to Jest's expect, but with type-awareness. Gives you access to a number of type-matchers that let you make assertions about the form of a reference or generic type parameter.

  1. ```typescript
  2. import {foo, bar} from '../foo'
  3. import {expectTypeOf} from 'expect-type'

  5. test('foo types', () => {
  6.   // make sure `foo` has type {a: number}
  7.   expectTypeOf(foo).toMatchTypeOf<{a: number}>()

  9.   // make sure `bar` is a function taking a string:
  10.   expectTypeOf(bar).parameter(0).toBeString()
  11.   expectTypeOf(bar).returns.not.toBeAny()
  12. })
  13. ```

It can be used in your existing test files - or any other type-checked file you'd like - it's built into existing tooling with no dependencies. No extra build step, cli tool, IDE extension, or lint plugin is needed. Just import the function and start writing tests. Failures will be at compile time - they'll appear in your IDE and when you run tsc.

See below for lots more examples.

Installation and usage


  1. ```cli
  2. npm install expect-type
  3. ```

  1. ```typescript
  2. import {expectTypeOf} from 'expect-type'
  3. ```

Documentation


The expectTypeOf method takes a single argument, or a generic parameter. Neither it, nor the functions chained off its return value, have any meaningful runtime behaviour. The assertions you write will be _compile-time_ errors if they don't hold true.

Features


Check an object's type with .toEqualTypeOf:

  1. ```typescript
  2. expectTypeOf({a: 1}).toEqualTypeOf<{a: number}>()
  3. ```

.toEqualTypeOf can check that two concrete objects have equivalent types:

  1. ```typescript
  2. expectTypeOf({a: 1}).toEqualTypeOf({a: 1})
  3. ```

.toEqualTypeOf succeeds for objects with different values, but the same type:

  1. ```typescript
  2. expectTypeOf({a: 1}).toEqualTypeOf({a: 2})
  3. ```

.toEqualTypeOf fails on extra properties:

  1. ```typescript
  2. // @ts-expect-error
  3. expectTypeOf({a: 1, b: 1}).toEqualTypeOf<{a: number}>()
  4. ```

To allow for extra properties, use .toMatchTypeOf. This checks that an object "matches" a type. This is similar to jest's .toMatchObject:

  1. ```typescript
  2. expectTypeOf({a: 1, b: 1}).toMatchTypeOf({a: 1})
  3. ```

Another example of the difference between .toMatchTypeOf and .toEqualTypeOf, using generics. .toMatchTypeOf can be used for "is-a" relationships:

  1. ```typescript
  2. type Fruit = {type: 'Fruit'; edible: boolean}
  3. type Apple = {type: 'Fruit'; name: 'Apple'; edible: true}

  5. expectTypeOf<Apple>().toMatchTypeOf<Fruit>()

  7. // @ts-expect-error
  8. expectTypeOf<Fruit>().toMatchTypeOf<Apple>()

  10. // @ts-expect-error
  11. expectTypeOf<Apple>().toEqualTypeOf<Fruit>()
  12. ```

Assertions can be inverted with .not:

  1. ```typescript
  2. expectTypeOf({a: 1}).not.toMatchTypeOf({b: 1})
  3. ```

.not can be easier than relying on // @ts-expect-error:

  1. ```typescript
  2. type Fruit = {type: 'Fruit'; edible: boolean}
  3. type Apple = {type: 'Fruit'; name: 'Apple'; edible: true}

  5. expectTypeOf<Apple>().toMatchTypeOf<Fruit>()

  7. expectTypeOf<Fruit>().not.toMatchTypeOf<Apple>()
  8. expectTypeOf<Apple>().not.toEqualTypeOf<Fruit>()
  9. ```

Catch any/unknown/never types:

  1. ```typescript
  2. expectTypeOf<unknown>().toBeUnknown()
  3. expectTypeOf<any>().toBeAny()
  4. expectTypeOf<never>().toBeNever()

  6. // @ts-expect-error
  7. expectTypeOf<never>().toBeNumber()
  8. ```

.toEqualTypeOf distinguishes between deeply-nested any and unknown properties:

  1. ```typescript
  2. expectTypeOf<{deeply: {nested: any}}>().not.toEqualTypeOf<{deeply: {nested: unknown}}>()
  3. ```

Test for basic javascript types:

  1. ```typescript
  2. expectTypeOf(() => 1).toBeFunction()
  3. expectTypeOf({}).toBeObject()
  4. expectTypeOf([]).toBeArray()
  5. expectTypeOf('').toBeString()
  6. expectTypeOf(1).toBeNumber()
  7. expectTypeOf(true).toBeBoolean()
  8. expectTypeOf(() => {}).returns.toBeVoid()
  9. expectTypeOf(Promise.resolve(123)).resolves.toBeNumber()
  10. expectTypeOf(Symbol(1)).toBeSymbol()
  11. ```

Nullable types:

  1. ```typescript
  2. expectTypeOf(undefined).toBeUndefined()
  3. expectTypeOf(undefined).toBeNullable()
  4. expectTypeOf(undefined).not.toBeNull()

  6. expectTypeOf(null).toBeNull()
  7. expectTypeOf(null).toBeNullable()
  8. expectTypeOf(null).not.toBeUndefined()

  10. expectTypeOf<1 | undefined>().toBeNullable()
  11. expectTypeOf<1 | null>().toBeNullable()
  12. expectTypeOf<1 | undefined | null>().toBeNullable()
  13. ```

More .not examples:

  1. ```typescript
  2. expectTypeOf(1).not.toBeUnknown()
  3. expectTypeOf(1).not.toBeAny()
  4. expectTypeOf(1).not.toBeNever()
  5. expectTypeOf(1).not.toBeNull()
  6. expectTypeOf(1).not.toBeUndefined()
  7. expectTypeOf(1).not.toBeNullable()
  8. ```

Detect assignability of unioned types:

  1. ```typescript
  2. expectTypeOf<number>().toMatchTypeOf<string | number>()
  3. expectTypeOf<string | number>().not.toMatchTypeOf<number>()
  4. ```

Use .extract and .exclude to narrow down complex union types:

  1. ```typescript
  2. type ResponsiveProp<T> = T | T[] | {xs?: T; sm?: T; md?: T}
  3. const getResponsiveProp = <T>(_props: T): ResponsiveProp<T> => ({})
  4. type CSSProperties = {margin?: string; padding?: string}

  6. const cssProperties: CSSProperties = {margin: '1px', padding: '2px'}

  8. expectTypeOf(getResponsiveProp(cssProperties))
  9.   .exclude<unknown[]>()
  10.   .exclude<{xs?: unknown}>()
  11.   .toEqualTypeOf<CSSProperties>()

  13. expectTypeOf(getResponsiveProp(cssProperties))
  14.   .extract<unknown[]>()
  15.   .toEqualTypeOf<CSSProperties[]>()

  17. expectTypeOf(getResponsiveProp(cssProperties))
  18.   .extract<{xs?: any}>()
  19.   .toEqualTypeOf<{xs?: CSSProperties; sm?: CSSProperties; md?: CSSProperties}>()

  21. expectTypeOf<ResponsiveProp<number>>().exclude<number | number[]>().toHaveProperty('sm')
  22. expectTypeOf<ResponsiveProp<number>>().exclude<number | number[]>().not.toHaveProperty('xxl')
  23. ```

.extract and .exclude return never if no types remain after exclusion:

  1. ```typescript
  2. type Person = {name: string; age: number}
  3. type Customer = Person & {customerId: string}
  4. type Employee = Person & {employeeId: string}

  6. expectTypeOf<Customer | Employee>().extract<{foo: string}>().toBeNever()
  7. expectTypeOf<Customer | Employee>().exclude<{name: string}>().toBeNever()
  8. ```

Make assertions about object properties:

  1. ```typescript
  2. const obj = {a: 1, b: ''}

  4. // check that properties exist (or don't) with `.toHaveProperty`
  5. expectTypeOf(obj).toHaveProperty('a')
  6. expectTypeOf(obj).not.toHaveProperty('c')

  8. // check types of properties
  9. expectTypeOf(obj).toHaveProperty('a').toBeNumber()
  10. expectTypeOf(obj).toHaveProperty('b').toBeString()
  11. expectTypeOf(obj).toHaveProperty('a').not.toBeString()
  12. ```

.toEqualTypeOf can be used to distinguish between functions:

  1. ```typescript
  2. type NoParam = () => void
  3. type HasParam = (s: string) => void

  5. expectTypeOf<NoParam>().not.toEqualTypeOf<HasParam>()
  6. ```

But often it's preferable to use .parameters or .returns for more specific function assertions:

  1. ```typescript
  2. type NoParam = () => void
  3. type HasParam = (s: string) => void

  5. expectTypeOf<NoParam>().parameters.toEqualTypeOf<[]>()
  6. expectTypeOf<NoParam>().returns.toBeVoid()

  8. expectTypeOf<HasParam>().parameters.toEqualTypeOf<[string]>()
  9. expectTypeOf<HasParam>().returns.toBeVoid()
  10. ```

More examples of ways to work with functions - parameters using .parameter(n) or .parameters, and return values using .returns:

  1. ```typescript
  2. const f = (a: number) => [a, a]

  4. expectTypeOf(f).toBeFunction()

  6. expectTypeOf(f).toBeCallableWith(1)
  7. expectTypeOf(f).not.toBeAny()
  8. expectTypeOf(f).returns.not.toBeAny()
  9. expectTypeOf(f).returns.toEqualTypeOf([1, 2])
  10. expectTypeOf(f).returns.toEqualTypeOf([1, 2, 3])
  11. expectTypeOf(f).parameter(0).not.toEqualTypeOf('1')
  12. expectTypeOf(f).parameter(0).toEqualTypeOf(1)
  13. expectTypeOf(1).parameter(0).toBeNever()

  15. const twoArgFunc = (a: number, b: string) => ({a, b})

  17. expectTypeOf(twoArgFunc).parameters.toEqualTypeOf<[number, string]>()
  18. ```

You can also check type guards & type assertions:

  1. ```typescript
  2. const assertNumber = (v: any): asserts v is number => {
  3.   if (typeof v !== 'number') {
  4.     throw new TypeError('Nope !')
  5.   }
  6. }

  8. expectTypeOf(assertNumber).asserts.toBeNumber()

  10. const isString = (v: any): v is string => typeof v === 'string'
  11. expectTypeOf(isString).guards.toBeString()
  12. ```

Assert on constructor parameters:

  1. ```typescript
  2. expectTypeOf(Date).toBeConstructibleWith('1970')
  3. expectTypeOf(Date).toBeConstructibleWith(0)
  4. expectTypeOf(Date).toBeConstructibleWith(new Date())
  5. expectTypeOf(Date).toBeConstructibleWith()

  7. expectTypeOf(Date).constructorParameters.toEqualTypeOf<[] | [string | number | Date]>()
  8. ```

Check function this parameters:

  1. ```typescript
  2. function greet(this: {name: string}, message: string) {
  3.   return `Hello ${this.name}, here's your message: ${message}`
  4. }

  6. expectTypeOf(greet).thisParameter.toEqualTypeOf<{name: string}>()
  7. ```

Distinguish between functions with different this parameters:

  1. ```typescript
  2. function greetFormal(this: {title: string; name: string}, message: string) {
  3.   return `Dear ${this.title} ${this.name}, here's your message: ${message}`
  4. }

  6. function greetCasual(this: {name: string}, message: string) {
  7.   return `Hi ${this.name}, here's your message: ${message}`
  8. }

  10. expectTypeOf(greetFormal).not.toEqualTypeOf(greetCasual)
  11. ```

Class instance types:

  1. ```typescript
  2. expectTypeOf(Date).instance.toHaveProperty('toISOString')
  3. ```

Promise resolution types can be checked with .resolves:

  1. ```typescript
  2. const asyncFunc = async () => 123

  4. expectTypeOf(asyncFunc).returns.resolves.toBeNumber()
  5. ```

Array items can be checked with .items:

  1. ```typescript
  2. expectTypeOf([1, 2, 3]).items.toBeNumber()
  3. expectTypeOf([1, 2, 3]).items.not.toBeString()
  4. ```

You can also compare arrays directly:

  1. ```typescript
  2. expectTypeOf<any[]>().not.toEqualTypeOf<number[]>()
  3. ```

Check that functions never return:

  1. ```typescript
  2. const thrower = () => {
  3.   throw new Error('oh no')
  4. }

  6. expectTypeOf(thrower).returns.toBeNever()
  7. ```

Generics can be used rather than references:

  1. ```typescript
  2. expectTypeOf<{a: string}>().not.toEqualTypeOf<{a: number}>()
  3. ```

Distinguish between missing/null/optional properties:

  1. ```typescript
  2. expectTypeOf<{a?: number}>().not.toEqualTypeOf<{}>()
  3. expectTypeOf<{a?: number}>().not.toEqualTypeOf<{a: number}>()
  4. expectTypeOf<{a?: number}>().not.toEqualTypeOf<{a: number | undefined}>()
  5. expectTypeOf<{a?: number | null}>().not.toEqualTypeOf<{a: number | null}>()
  6. expectTypeOf<{a: {b?: number}}>().not.toEqualTypeOf<{a: {}}>()
  7. ```

Detect the difference between regular and readonly properties:

  1. ```typescript
  2. type A1 = {readonly a: string; b: string}
  3. type E1 = {a: string; b: string}

  5. expectTypeOf<A1>().toMatchTypeOf<E1>()
  6. expectTypeOf<A1>().not.toEqualTypeOf<E1>()

  8. type A2 = {a: string; b: {readonly c: string}}
  9. type E2 = {a: string; b: {c: string}}

  11. expectTypeOf<A2>().toMatchTypeOf<E2>()
  12. expectTypeOf<A2>().not.toEqualTypeOf<E2>()
  13. ```

Distinguish between classes with different constructors:

  1. ```typescript
  2. class A {
  3.   value: number
  4.   constructor(a: 1) {
  5.     this.value = a
  6.   }
  7. }
  8. class B {
  9.   value: number
  10.   constructor(b: 2) {
  11.     this.value = b
  12.   }
  13. }

  15. expectTypeOf<typeof A>().not.toEqualTypeOf<typeof B>()

  17. class C {
  18.   value: number
  19.   constructor(c: 1) {
  20.     this.value = c
  21.   }
  22. }

  24. expectTypeOf<typeof A>().toEqualTypeOf<typeof C>()
  25. ```

Known limitation: Intersection types can cause issues with toEqualTypeOf:

  1. ```typescript
  2. // @ts-expect-error the following line doesn't compile, even though the types are arguably the same.
  3. // See https://github.com/mmkal/expect-type/pull/21
  4. expectTypeOf<{a: 1} & {b: 2}>().toEqualTypeOf<{a: 1; b: 2}>()
  5. ```

To workaround, you can use a mapped type:

  1. ```typescript
  2. type Simplify<T> = {[K in keyof T]: T[K]}

  4. expectTypeOf<Simplify<{a: 1} & {b: 2}>>().toEqualTypeOf<{a: 1; b: 2}>()
  5. ```

Within test frameworks


Jest & eslint-plugin-jest

If you're using Jest along with eslint-plugin-jest, you will get warnings from the [jest/expect-expect](https://github.com/jest-community/eslint-plugin-jest/blob/master/docs/rules/expect-expect.md) rule, complaining that "Test has no assertions" for tests that only use expectTypeOf().

To remove this warning, configure the ESlint rule to consider expectTypeOf as an assertion:

  1. ```js
  2. "rules": {
  3.   // ...
  4.   "jest/expect-expect": [
  5.     "warn",
  6.     {
  7.       "assertFunctionNames": [
  8.         "expect", "expectTypeOf"
  9.       ]
  10.     }
  11.   ],
  12.   // ...
  13. }
  14. ```

Similar projects


Other projects with similar goals:

- [tsd](https://github.com/SamVerschueren/tsd) is a CLI that runs the TypeScript type checker over assertions
- [ts-expect](https://github.com/TypeStrong/ts-expect) exports several generic helper types to perform type assertions
- [dtslint](https://github.com/Microsoft/dtslint) does type checks via comment directives and tslint
- [type-plus](https://github.com/unional/type-plus) comes with various type and runtime TypeScript assertions
- [static-type-assert](https://github.com/ksxnodemodules/static-type-assert) type assertion functions

Comparison


The key differences in this project are:

- a fluent, jest-inspired API, making the difference between actual and expected clear. This is helpful with complex types and assertions.
- inverting assertions intuitively and easily via expectTypeOf(...).not
- checks generics properly and strictly (tsd doesn't)
- first-class support for:
  - any (as well as unknown and never) (see issues outstanding at time of writing in tsd for never and any).
    - This can be especially useful in combination with not, to protect against functions returning too-permissive types. For example, const parseFile = (filename: string) => JSON.parse(readFileSync(filename).toString()) returns any, which could lead to errors. After giving it a proper return-type, you can add a test for this with expect(parseFile).returns.not.toBeAny()
  - object properties
  - function parameters
  - function return values
  - constructor parameters
  - class instances
  - array item values
  - nullable types
- assertions on types "matching" rather than exact type equality, for "is-a" relationships e.g. `expectTypeOf(square).toMatchTypeOf()`
- built into existing tooling. No extra build step, cli tool, IDE extension, or lint plugin is needed. Just import the function and start writing tests. Failures will be at compile time - they'll appear in your IDE and when you run tsc.
- small implementation with no dependencies. <200 lines of code - take a look! (tsd, for comparison, is 2.6MB because it ships a patched version of typescript).

Contributing


In most cases, it's worth checking existing issues or creating on to discuss a new feature or a bug fix before opening a pull request.

Once you're ready to make a pull request: clone the repo, and install pnpm if you don't have it already with npm install --global pnpm. Lockfiles for npm and yarn are gitignored.

If you're adding a feature, you should write a self-contained usage example in the form of a test, in test/usage.test.ts. This file is used to populate the bulk of this readme using eslint-plugin-codegen, and to generate an "errors" test file, which captures the error messages that are emitted for failing assertions by the typescript compiler. So, the test name should be written as a human-readable sentence explaining the usage example. Have a look at the existing tests for an idea of the style.

After adding the tests, run npm run lint -- --fix to update the readme, and npm test -- --updateSnapshot to update the errors test. The generated documentation and tests should be pushed to the same branch as the source code, and submitted as a pull request. CI will test that the docs and tests are up to date if you forget to run these commands.