Skip to content

Commit

Permalink
Add new asserting types such to readme toc
Browse files Browse the repository at this point in the history
  • Loading branch information
ecooper committed Jul 29, 2024
1 parent aed5992 commit 195b90c
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ See the [Fauna Documentation](https://docs.fauna.com/fauna/current/) for additio
- [Contributing](#contributing)
- [Set up the repo](#set-up-the-repo)
- [Run tests](#run-tests)
- [Asserting types](#asserting-types)
- [Lint your code](#lint-your-code)
- [License](#license)

Expand Down Expand Up @@ -602,7 +603,7 @@ Don't forget to give the project a star! Thanks again!
1. Start a docker desktop or other docker platform.
2. Run `yarn test`. This will start local fauna containers, verify they're up and run all tests.

### Asserting type behavior
### Asserting types

In cases where you are modifying types and need to test type enforcement, you can use `@ts-expect-error`. Using `@ts-expect-error` will supress any type errors on the following line. Conversely, if there's no error, TypeScript will report its usage as not being neccessary.

Expand Down

0 comments on commit 195b90c

Please sign in to comment.