rename Result.matchRefined to matchWithError

tim-smart · Jun 6, 2024 · af598a2 · af598a2
1 parent 02c2bea
commit af598a2
Show file tree

Hide file tree

Showing 3 changed files with 85 additions and 26 deletions.
diff --git a/.changeset/new-adults-accept.md b/.changeset/new-adults-accept.md
@@ -0,0 +1,5 @@
+---
+"@effect-rx/rx": patch
+---
+
+rename Result.matchRefined to matchWithError
diff --git a/docs/rx/Result.ts.md b/docs/rx/Result.ts.md
@@ -19,6 +19,8 @@ Added in v1.0.0
 - [combinators](#combinators)
   - [map](#map)
   - [match](#match)
+  - [matchWithError](#matchwitherror)
+  - [matchWithWaiting](#matchwithwaiting)
   - [toExit](#toexit)
 - [constructors](#constructors)
   - [fail](#fail)
@@ -128,6 +130,58 @@ export declare const match: {
 
 Added in v1.0.0
 
+## matchWithError
+
+**Signature**
+
+```ts
+export declare const matchWithError: {
+  <A, E, W, X, Y, Z>(options: {
+    readonly onInitial: (_: Initial<A, E>) => W
+    readonly onError: (error: E, _: Failure<A, E>) => X
+    readonly onDefect: (defect: unknown, _: Failure<A, E>) => Y
+    readonly onSuccess: (_: Success<A, E>) => Z
+  }): (self: Result<A, E>) => W | X | Y | Z
+  <A, E, W, X, Y, Z>(
+    self: Result<A, E>,
+    options: {
+      readonly onInitial: (_: Initial<A, E>) => W
+      readonly onError: (error: E, _: Failure<A, E>) => X
+      readonly onDefect: (defect: unknown, _: Failure<A, E>) => Y
+      readonly onSuccess: (_: Success<A, E>) => Z
+    }
+  ): W | X | Y | Z
+}
+```
+
+Added in v1.0.0
+
+## matchWithWaiting
+
+**Signature**
+
+```ts
+export declare const matchWithWaiting: {
+  <A, E, W, X, Y, Z>(options: {
+    readonly onWaiting: (_: Result<A, E>) => W
+    readonly onError: (error: E, _: Failure<A, E>) => X
+    readonly onDefect: (defect: unknown, _: Failure<A, E>) => Y
+    readonly onSuccess: (_: Success<A, E>) => Z
+  }): (self: Result<A, E>) => W | X | Y | Z
+  <A, E, W, X, Y, Z>(
+    self: Result<A, E>,
+    options: {
+      readonly onWaiting: (_: Result<A, E>) => W
+      readonly onError: (error: E, _: Failure<A, E>) => X
+      readonly onDefect: (defect: unknown, _: Failure<A, E>) => Y
+      readonly onSuccess: (_: Success<A, E>) => Z
+    }
+  ): W | X | Y | Z
+}
+```
+
+Added in v1.0.0
+
 ## toExit
 
 **Signature**

diff --git a/packages/rx/src/Result.ts b/packages/rx/src/Result.ts
@@ -359,25 +359,25 @@ export const match: {
  * @since 1.0.0
  * @category combinators
  */
-export const matchRefined: {
-  <A, E, X, Y, Z>(options: {
-    readonly onInitial: (_: Initial<A, E>) => X
-    readonly onError: (error: E, _: Failure<A, E>) => Y
+export const matchWithError: {
+  <A, E, W, X, Y, Z>(options: {
+    readonly onInitial: (_: Initial<A, E>) => W
+    readonly onError: (error: E, _: Failure<A, E>) => X
     readonly onDefect: (defect: unknown, _: Failure<A, E>) => Y
     readonly onSuccess: (_: Success<A, E>) => Z
-  }): (self: Result<A, E>) => X | Y | Z
-  <A, E, X, Y, Z>(self: Result<A, E>, options: {
-    readonly onInitial: (_: Initial<A, E>) => X
-    readonly onError: (error: E, _: Failure<A, E>) => Y
+  }): (self: Result<A, E>) => W | X | Y | Z
+  <A, E, W, X, Y, Z>(self: Result<A, E>, options: {
+    readonly onInitial: (_: Initial<A, E>) => W
+    readonly onError: (error: E, _: Failure<A, E>) => X
     readonly onDefect: (defect: unknown, _: Failure<A, E>) => Y
     readonly onSuccess: (_: Success<A, E>) => Z
-  }): X | Y | Z
-} = dual(2, <A, E, X, Y, Z>(self: Result<A, E>, options: {
-  readonly onInitial: (_: Initial<A, E>) => X
-  readonly onError: (error: E, _: Failure<A, E>) => Y
+  }): W | X | Y | Z
+} = dual(2, <A, E, W, X, Y, Z>(self: Result<A, E>, options: {
+  readonly onInitial: (_: Initial<A, E>) => W
+  readonly onError: (error: E, _: Failure<A, E>) => X
   readonly onDefect: (defect: unknown, _: Failure<A, E>) => Y
   readonly onSuccess: (_: Success<A, E>) => Z
-}): X | Y | Z => {
+}): W | X | Y | Z => {
   switch (self._tag) {
     case "Initial":
       return options.onInitial(self)
@@ -397,25 +397,25 @@ export const matchRefined: {
  * @since 1.0.0
  * @category combinators
  */
-export const matchRefinedWaiting: {
-  <A, E, X, Y, Z>(options: {
-    readonly onWaiting: (_: Result<A, E>) => X
-    readonly onError: (error: E, _: Failure<A, E>) => Y
+export const matchWithWaiting: {
+  <A, E, W, X, Y, Z>(options: {
+    readonly onWaiting: (_: Result<A, E>) => W
+    readonly onError: (error: E, _: Failure<A, E>) => X
     readonly onDefect: (defect: unknown, _: Failure<A, E>) => Y
     readonly onSuccess: (_: Success<A, E>) => Z
-  }): (self: Result<A, E>) => X | Y | Z
-  <A, E, X, Y, Z>(self: Result<A, E>, options: {
-    readonly onWaiting: (_: Result<A, E>) => X
-    readonly onError: (error: E, _: Failure<A, E>) => Y
+  }): (self: Result<A, E>) => W | X | Y | Z
+  <A, E, W, X, Y, Z>(self: Result<A, E>, options: {
+    readonly onWaiting: (_: Result<A, E>) => W
+    readonly onError: (error: E, _: Failure<A, E>) => X
     readonly onDefect: (defect: unknown, _: Failure<A, E>) => Y
     readonly onSuccess: (_: Success<A, E>) => Z
-  }): X | Y | Z
-} = dual(2, <A, E, X, Y, Z>(self: Result<A, E>, options: {
-  readonly onWaiting: (_: Result<A, E>) => X
-  readonly onError: (error: E, _: Failure<A, E>) => Y
+  }): W | X | Y | Z
+} = dual(2, <A, E, W, X, Y, Z>(self: Result<A, E>, options: {
+  readonly onWaiting: (_: Result<A, E>) => W
+  readonly onError: (error: E, _: Failure<A, E>) => X
   readonly onDefect: (defect: unknown, _: Failure<A, E>) => Y
   readonly onSuccess: (_: Success<A, E>) => Z
-}): X | Y | Z => {
+}): W | X | Y | Z => {
   if (self.waiting) {
     return options.onWaiting(self)
   }