diff --git a/docs/rx/Rx.ts.md b/docs/rx/Rx.ts.md index fbc013a..4fea597 100644 --- a/docs/rx/Rx.ts.md +++ b/docs/rx/Rx.ts.md @@ -21,6 +21,7 @@ Added in v1.0.0 - [mapResult](#mapresult) - [refreshable](#refreshable) - [setIdleTTL](#setidlettl) + - [withFallback](#withfallback) - [withLabel](#withlabel) - [constructors](#constructors) - [effect](#effect) @@ -170,6 +171,27 @@ export declare const setIdleTTL: { Added in v1.0.0 +## withFallback + +**Signature** + +```ts +export declare const withFallback: { + (fallback: Rx>): >>( + self: R + ) => [R] extends [Writable] + ? Writable>, A2 | Result.Result.Success>>, RW> + : Rx>, A2 | Result.Result.Success>>> + >, E2, A2>(self: R, fallback: Rx>): [R] extends [ + Writable + ] + ? Writable>, A2 | Result.Result.Success>>, RW> + : Rx>, A2 | Result.Result.Success>>> +} +``` + +Added in v1.0.0 + ## withLabel **Signature** @@ -191,10 +213,13 @@ Added in v1.0.0 ```ts export declare const effect: { - (create: Rx.Read>): Rx> + ( + create: Rx.Read>, + options?: { readonly initialValue?: A | undefined; readonly runtime?: undefined } | undefined + ): Rx> ( create: Rx.Read>, - options: { readonly runtime: RxRuntime } + options: { readonly runtime: RxRuntime; readonly initialValue?: A | undefined } ): Rx> } ``` @@ -207,10 +232,13 @@ Added in v1.0.0 ```ts export declare const effectFn: { - (fn: Rx.ReadFn>): RxResultFn + ( + fn: Rx.ReadFn>, + options?: { readonly initialValue?: A | undefined; readonly runtime?: undefined } | undefined + ): RxResultFn ( fn: Rx.ReadFn>, - options: { readonly runtime: RxRuntime } + options: { readonly runtime: RxRuntime; readonly initialValue?: A | undefined } ): RxResultFn } ``` @@ -232,7 +260,10 @@ Added in v1.0.0 **Signature** ```ts -export declare const fn: (f: Rx.ReadFn) => Writable, Arg> +export declare const fn: { + (f: Rx.ReadFn): Writable, Arg> + (f: Rx.ReadFn, options: { readonly initialValue: A }): Writable +} ``` Added in v1.0.0 @@ -255,9 +286,13 @@ Added in v1.0.0 export declare const runtime: { ( layer: Layer.Layer, - options?: { readonly autoDispose?: boolean; readonly idleTTL?: Duration.DurationInput } + options?: { + readonly autoDispose?: boolean + readonly idleTTL?: Duration.DurationInput + readonly runtime?: undefined + } ): RxRuntime - ( + ( layer: Layer.Layer, options?: | { @@ -266,7 +301,7 @@ export declare const runtime: { readonly runtime: RxRuntime } | undefined - ): RxRuntime + ): RxRuntime } ``` @@ -278,10 +313,13 @@ Added in v1.0.0 ```ts export declare const scoped: { - (create: Rx.Read>): Rx> + ( + create: Rx.Read>, + options?: { readonly initialValue?: A | undefined; readonly runtime?: undefined } | undefined + ): Rx> ( create: Rx.Read>, - options: { readonly runtime: RxRuntime } + options: { readonly initialValue?: A | undefined; readonly runtime: RxRuntime } ): Rx> } ``` @@ -294,10 +332,13 @@ Added in v1.0.0 ```ts export declare const scopedFn: { - (fn: Rx.ReadFn>): RxResultFn + ( + fn: Rx.ReadFn>, + options?: { readonly initialValue?: A | undefined; readonly runtime?: undefined } | undefined + ): RxResultFn ( fn: Rx.ReadFn>, - options: { readonly runtime: RxRuntime } + options: { readonly initialValue?: A | undefined; readonly runtime: RxRuntime } ): RxResultFn } ``` @@ -320,10 +361,13 @@ Added in v1.0.0 ```ts export declare const stream: { - (create: Rx.Read>): Rx> + ( + create: Rx.Read>, + options?: { readonly initialValue?: A | undefined; readonly runtime?: undefined } | undefined + ): Rx> ( create: Rx.Read>, - options: { readonly runtime: RxRuntime } + options: { readonly initialValue?: A | undefined; readonly runtime: RxRuntime } ): Rx> } ``` @@ -336,10 +380,13 @@ Added in v1.0.0 ```ts export declare const streamFn: { - (fn: Rx.ReadFn>): RxResultFn + ( + fn: Rx.ReadFn>, + options?: { readonly initialValue?: A | undefined; readonly runtime?: undefined } | undefined + ): RxResultFn ( fn: Rx.ReadFn>, - options: { readonly runtime: RxRuntime } + options: { readonly runtime: RxRuntime; readonly initialValue?: A | undefined } ): RxResultFn } ``` @@ -352,13 +399,23 @@ Added in v1.0.0 ```ts export declare const streamPull: { - (create: Rx.Read>, options?: { readonly disableAccumulation?: boolean }): Writable< - StreamPullResult, - void - > + ( + create: Rx.Read>, + options?: + | { + readonly disableAccumulation?: boolean | undefined + readonly initialValue?: readonly A[] | undefined + readonly runtime?: undefined + } + | undefined + ): Writable, void> ( create: Rx.Read>, - options: { readonly runtime: RxRuntime; readonly disableAccumulation?: boolean | undefined } + options: { + readonly runtime: RxRuntime + readonly disableAccumulation?: boolean | undefined + readonly initialValue?: readonly A[] | undefined + } ): Writable, void> } ```