typings-tester

TypeScript definition testing library

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
typings-tester
4620.3.26 years ago8 years agoMinified + gzip package size for typings-tester in KB

Readme

A library aimed to aid testing of TypeScript definitions. Checks TypeScript files for syntactic, expected and unexpected semantic (type) errors.

Installation

$ npm install -D typings-tester
Any version of TypeScript must be installed separately.

CLI Usage

$ typings-tester --config path/to/tsconfig.json **/*.ts
 
$ typings-tester --dir path/to/directory

API Usage

import test from "tape";
import {check, checkDirectory} from "typings-tester";


test('typings', assert => {
  assert.doesNotThrow(() => check(['test.ts'], 'tsconfig.json'));
  
  assert.doesNotThrow(() => checkDirectory('src'));
});

Flags

  • typings:expect-error: expect next line or block to contain semantic error. typings-tester will fail if no error is produced.

// typings:expect-error
function shouldFail(a: number): string {
  return a;
}

What's next

  • Testing against multiple versions of TypeScript
  • Inferred type assertions