Skip to content

Commit

Permalink
Tweak readme.md (#66)
Browse files Browse the repository at this point in the history
Co-authored-by: Ethan Arrowood <[email protected]>
  • Loading branch information
papb and Ethan-Arrowood authored Aug 12, 2020
1 parent 4a31b01 commit 7bfdddf
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ $ npm install tsd
```


## Overview

This tool lets you write tests for your type definitions (i.e. your `.d.ts` files) by creating files with the `.test-d.ts` extension.

These `.test-d.ts` files will not be executed, and not even compiled in the standard way. Instead, these files will be parsed for special constructs such as `expectError<Foo>(bar)` and then statically analyzed against your type definitions.


## Usage

Let's assume we wrote a `index.d.ts` type definition for our concat module.
Expand Down

0 comments on commit 7bfdddf

Please sign in to comment.