feat: adds unwrap

OctoD · Jul 15, 2019 · e0ca437 · e0ca437
1 parent 8c505c7
commit e0ca437
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/src/Result.ts b/src/Result.ts
@@ -134,6 +134,19 @@ class Result<R, E> {
 
     return this;
   }
+
+  /**
+   * Returns wrapped value or throws an `Error`
+   * @returns {(R | never)}
+   * @memberof Result
+   */
+  public unwrap(): R | never {
+    if (instanceOfError<R, E>(this.value)) {
+      throw this.value;
+    }
+
+    return this.value;
+  }
 }
 
 /**

diff --git a/src/__tests__/Result.spec.ts b/src/__tests__/Result.spec.ts
@@ -54,4 +54,9 @@ describe(`Result`, () => {
     expect(Ok("a").orElse(() => Ok("b"))).toStrictEqual(Ok("a"));
     expect(Err("a").orElse(() => Ok("b"))).toStrictEqual(Ok("b"));
   });
+
+  it("Returns wrapped value or throws an `Error`", () => {
+    expect(Ok("a").unwrap()).toBe("a");
+    expect(() => Err("a").unwrap()).toThrowError();
+  });
 });