From 910789d42f2cc8469f5fad2b80b1844e0c063269 Mon Sep 17 00:00:00 2001 From: TheDudeFromCI Date: Sat, 25 Dec 2021 21:38:26 -0700 Subject: [PATCH] Update README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 643f362..4476c19 100644 --- 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