feat: adds unwrapOr

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

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/src/Result.ts b/src/Result.ts
@@ -147,6 +147,21 @@ class Result<R, E> {
 
     return this.value;
   }
+
+  /**
+   * Unwraps a result, yielding the content of an `Ok`. Else, it returns `optb`.
+   * @template U
+   * @param {U} optb
+   * @returns {(R | U)}
+   * @memberof Result
+   */
+  public unwrapOr<U>(optb: U): R | U {
+    if (instanceOfError<R, E>(this.value)) {
+      return optb;
+    }
+
+    return this.value;
+  }
 }
 
 /**

diff --git a/src/__tests__/Result.spec.ts b/src/__tests__/Result.spec.ts
@@ -59,4 +59,9 @@ describe(`Result`, () => {
     expect(Ok("a").unwrap()).toBe("a");
     expect(() => Err("a").unwrap()).toThrowError();
   });
+
+  it("Unwraps a result, yielding the content of an `Ok`. Else, it returns `optb`.", () => {
+    expect(Ok("a").unwrapOr(Ok("b"))).toBe("a");
+    expect(Err("a").unwrapOr("b")).toBe("b");
+  });
 });