Update README.md

vultix · Nov 12, 2022 · 910789d · 910789d
1 parent d0fb55a
commit 910789d
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,7 @@ Brings compile-time error checking and optional values to typescript.
     -   [Type Safety](#type-safety)
     -   [Unwrap](#unwrap)
     -   [Expect](#expect)
+    -   [ExpectErr](#expecterr)
     -   [Map, MapErr](#map-and-maperr)
     -   [andThen](#andthen)
     -   [Else](#else)
@@ -202,6 +203,17 @@ goodResult.expect('goodResult should be a number'); // 1
 badResult.expect('badResult should be a number'); // throws Error("badResult should be a number - Error: something went wrong")
 ```
 
+#### ExpectErr
+
+```typescript
+let goodResult = Ok(1);
+let badResult = Err(new Error('something went wrong'));
+
+goodResult.expect('goodResult should not be a number'); // throws Error("goodResult should not be a number")
+badResult.expect('badResult should not be a number'); // new Error('something went wrong')
+```
+
+
 #### Map and MapErr
 
 ```typescript