fix: adjust meaning of asserts

JanMalch · Oct 30, 2020 · 32e4c67 · 32e4c67
1 parent cc16ac3
commit 32e4c67
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -200,7 +200,7 @@ export function unreachable(_value: never): never;
 
 ### `asserts`
 
-Use it for any other assertions, that don't quite fit the other contexts.
+Use it to clarify, that something happened that you thought was impossible to happen.
 
 ```ts
 /**
@@ -211,7 +211,7 @@ Use it for any other assertions, that don't quite fit the other contexts.
  */
 export function asserts(
   condition: boolean,
-  message: string = 'Failed Assertion'
+  message?: string
 ): asserts condition;
 ```
 

diff --git a/index.ts b/index.ts
@@ -177,7 +177,7 @@ export function ensuresNonNullish<T>(
  */
 export function asserts(
   condition: boolean,
-  message = 'Failed Assertion'
+  message?: string
 ): asserts condition {
   if (!condition) {
     throw new AssertionError(message);