From 58e5473cce522dd20f53bd26f5d3e0d0b3371cf0 Mon Sep 17 00:00:00 2001 From: Sebastien Guillemot Date: Tue, 13 Sep 2022 01:51:01 +0900 Subject: [PATCH] Doc suggestion fix #1 Co-authored-by: Tommy --- readme.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index ddfb4b3a..fefaf64f 100644 --- a/readme.md +++ b/readme.md @@ -189,9 +189,11 @@ Check that `value` is marked a [`@deprecated`](https://jsdoc.app/tags-deprecated Check that `value` is not marked a [`@deprecated`](https://jsdoc.app/tags-deprecated.html). -### expectNever<T>(value) +### expectNever(expression: never) -Check that the type of `value` is `never` and also returns `never` (useful for checking all branches are covered). +Asserts that the type and return type of `expression` is `never`. + +Useful for checking that all branches are covered. ### printType(value)