From af598a2d410f48e1de9f87dcfe42a49e0592227a Mon Sep 17 00:00:00 2001 From: Tim Date: Thu, 6 Jun 2024 21:46:03 +1200 Subject: [PATCH] rename Result.matchRefined to matchWithError --- .changeset/new-adults-accept.md | 5 +++ docs/rx/Result.ts.md | 54 +++++++++++++++++++++++++++++++++ packages/rx/src/Result.ts | 52 +++++++++++++++---------------- 3 files changed, 85 insertions(+), 26 deletions(-) create mode 100644 .changeset/new-adults-accept.md diff --git a/.changeset/new-adults-accept.md b/.changeset/new-adults-accept.md new file mode 100644 index 0000000..3684251 --- /dev/null +++ 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 index 8b3385d..d5a70cb 100644 --- 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: { + (options: { + readonly onInitial: (_: Initial) => W + readonly onError: (error: E, _: Failure) => X + readonly onDefect: (defect: unknown, _: Failure) => Y + readonly onSuccess: (_: Success) => Z + }): (self: Result) => W | X | Y | Z + ( + self: Result, + options: { + readonly onInitial: (_: Initial) => W + readonly onError: (error: E, _: Failure) => X + readonly onDefect: (defect: unknown, _: Failure) => Y + readonly onSuccess: (_: Success) => Z + } + ): W | X | Y | Z +} +``` + +Added in v1.0.0 + +## matchWithWaiting + +**Signature** + +```ts +export declare const matchWithWaiting: { + (options: { + readonly onWaiting: (_: Result) => W + readonly onError: (error: E, _: Failure) => X + readonly onDefect: (defect: unknown, _: Failure) => Y + readonly onSuccess: (_: Success) => Z + }): (self: Result) => W | X | Y | Z + ( + self: Result, + options: { + readonly onWaiting: (_: Result) => W + readonly onError: (error: E, _: Failure) => X + readonly onDefect: (defect: unknown, _: Failure) => Y + readonly onSuccess: (_: Success) => 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 index 93474b6..dd96b14 100644 --- 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: { - (options: { - readonly onInitial: (_: Initial) => X - readonly onError: (error: E, _: Failure) => Y +export const matchWithError: { + (options: { + readonly onInitial: (_: Initial) => W + readonly onError: (error: E, _: Failure) => X readonly onDefect: (defect: unknown, _: Failure) => Y readonly onSuccess: (_: Success) => Z - }): (self: Result) => X | Y | Z - (self: Result, options: { - readonly onInitial: (_: Initial) => X - readonly onError: (error: E, _: Failure) => Y + }): (self: Result) => W | X | Y | Z + (self: Result, options: { + readonly onInitial: (_: Initial) => W + readonly onError: (error: E, _: Failure) => X readonly onDefect: (defect: unknown, _: Failure) => Y readonly onSuccess: (_: Success) => Z - }): X | Y | Z -} = dual(2, (self: Result, options: { - readonly onInitial: (_: Initial) => X - readonly onError: (error: E, _: Failure) => Y + }): W | X | Y | Z +} = dual(2, (self: Result, options: { + readonly onInitial: (_: Initial) => W + readonly onError: (error: E, _: Failure) => X readonly onDefect: (defect: unknown, _: Failure) => Y readonly onSuccess: (_: Success) => 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: { - (options: { - readonly onWaiting: (_: Result) => X - readonly onError: (error: E, _: Failure) => Y +export const matchWithWaiting: { + (options: { + readonly onWaiting: (_: Result) => W + readonly onError: (error: E, _: Failure) => X readonly onDefect: (defect: unknown, _: Failure) => Y readonly onSuccess: (_: Success) => Z - }): (self: Result) => X | Y | Z - (self: Result, options: { - readonly onWaiting: (_: Result) => X - readonly onError: (error: E, _: Failure) => Y + }): (self: Result) => W | X | Y | Z + (self: Result, options: { + readonly onWaiting: (_: Result) => W + readonly onError: (error: E, _: Failure) => X readonly onDefect: (defect: unknown, _: Failure) => Y readonly onSuccess: (_: Success) => Z - }): X | Y | Z -} = dual(2, (self: Result, options: { - readonly onWaiting: (_: Result) => X - readonly onError: (error: E, _: Failure) => Y + }): W | X | Y | Z +} = dual(2, (self: Result, options: { + readonly onWaiting: (_: Result) => W + readonly onError: (error: E, _: Failure) => X readonly onDefect: (defect: unknown, _: Failure) => Y readonly onSuccess: (_: Success) => Z -}): X | Y | Z => { +}): W | X | Y | Z => { if (self.waiting) { return options.onWaiting(self) }