From ff86470fa608ebb68e142dcb5c595095f45ec664 Mon Sep 17 00:00:00 2001 From: Jesse Kelly Date: Wed, 28 Feb 2024 18:43:19 -0600 Subject: [PATCH] updated docs --- docs/rx-react/index.ts.md | 4 ++-- docs/rx/Result.ts.md | 16 +++++++++++++--- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/rx-react/index.ts.md b/docs/rx-react/index.ts.md index b42d11c..32400ef 100644 --- a/docs/rx-react/index.ts.md +++ b/docs/rx-react/index.ts.md @@ -95,7 +95,7 @@ Added in v1.0.0 **Signature** ```ts -export declare const useRxRefresh: (rx: Rx.Rx & Rx.Refreshable) => () => void +export declare const useRxRefresh: (rx: any) => () => void ``` Added in v1.0.0 @@ -144,7 +144,7 @@ Added in v1.0.0 export declare const useRxSuspense: ( rx: Rx.Rx>, options?: { readonly suspendOnWaiting?: boolean } -) => Result.Success | Result.Failure +) => any ``` Added in v1.0.0 diff --git a/docs/rx/Result.ts.md b/docs/rx/Result.ts.md index 47abc2a..9b4b2cd 100644 --- a/docs/rx/Result.ts.md +++ b/docs/rx/Result.ts.md @@ -96,10 +96,20 @@ Added in v1.0.0 ```ts export declare const match: { - (options: MatchOptions): (self: Result) => X | Y | Z - (self: Result, options: MatchOptions): X | Y | Z + (options: { + readonly onInitial: (_: Initial) => X + readonly onFailure: (_: Failure) => Y + readonly onSuccess: (_: Success) => Z + }): (self: Result) => X | Y | Z + ( + self: Result, + options: { + readonly onInitial: (_: Initial) => X + readonly onFailure: (_: Failure) => Y + readonly onSuccess: (_: Success) => Z + } + ): X | Y | Z } -======= ``` Added in v1.0.0