Skip to content

Commit 7bfdddf

Browse files
papbEthan-Arrowood
andauthored
Tweak readme.md (#66)
Co-authored-by: Ethan Arrowood <[email protected]>
1 parent 4a31b01 commit 7bfdddf

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

readme.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ $ npm install tsd
1010
```
1111

1212

13+
## Overview
14+
15+
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.
16+
17+
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.
18+
19+
1320
## Usage
1421

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

0 commit comments

Comments
 (0)