chore: update docs

TylorS · Feb 29, 2024 · d8cc097 · d8cc097
1 parent 02fbf69
commit d8cc097
Show file tree

Hide file tree

Showing 8 changed files with 102 additions and 11 deletions.
diff --git a/docs/fx/Fx.ts.md b/docs/fx/Fx.ts.md
@@ -54,7 +54,9 @@ Added in v1.20.0
     - [toEffect (method)](#toeffect-method)
   - [KeyedOptions (interface)](#keyedoptions-interface)
   - [MatchCauseOptions (type alias)](#matchcauseoptions-type-alias)
+  - [MatchCauseOptionsEffect (type alias)](#matchcauseoptionseffect-type-alias)
   - [MatchErrorOptions (type alias)](#matcherroroptions-type-alias)
+  - [MatchErrorOptionsEffect (type alias)](#matcherroroptionseffect-type-alias)
   - [Success (type alias)](#success-type-alias-1)
   - [Unify (type alias)](#unify-type-alias-1)
   - [WithKeyOptions (interface)](#withkeyoptions-interface)
@@ -198,6 +200,8 @@ Added in v1.20.0
   - [periodic](#periodic)
   - [prepend](#prepend)
   - [prependAll](#prependall)
+  - [promise](#promise)
+  - [promiseFx](#promisefx)
   - [provide](#provide)
   - [provideContext](#providecontext)
   - [provideLayer](#providelayer)
@@ -227,7 +231,9 @@ Added in v1.20.0
   - [switchMapEffect](#switchmapeffect)
   - [switchMapError](#switchmaperror)
   - [switchMatchCause](#switchmatchcause)
+  - [switchMatchCauseEffect](#switchmatchcauseeffect)
   - [switchMatchError](#switchmatcherror)
+  - [switchMatchErrorEffect](#switchmatcherroreffect)
   - [sync](#sync)
   - [take](#take)
   - [takeUntiEffect](#takeuntieffect)
@@ -719,6 +725,20 @@ export type MatchCauseOptions<E, A, B, E2, R2, C, E3, R3> = {
 
 Added in v1.20.0
 
+## MatchCauseOptionsEffect (type alias)
+
+**Signature**
+
+```ts
+export type MatchCauseOptionsEffect<E, A, B, E2, R2, C, E3, R3> = {
+  readonly onFailure: (cause: Cause.Cause<E>) => Effect.Effect<B, E2, R2>
+  readonly onSuccess: (a: A) => Effect.Effect<C, E3, R3>
+  readonly executionStrategy?: ExecutionStrategy.ExecutionStrategy | undefined
+}
+```
+
+Added in v1.20.0
+
 ## MatchErrorOptions (type alias)
 
 **Signature**
@@ -733,6 +753,20 @@ export type MatchErrorOptions<E, A, B, E2, R2, C, E3, R3> = {
 
 Added in v1.20.0
 
+## MatchErrorOptionsEffect (type alias)
+
+**Signature**
+
+```ts
+export type MatchErrorOptionsEffect<E, A, B, E2, R2, C, E3, R3> = {
+  readonly onFailure: (e: E) => Effect.Effect<B, E2, R2>
+  readonly onSuccess: (a: A) => Effect.Effect<C, E3, R3>
+  readonly executionStrategy?: ExecutionStrategy.ExecutionStrategy | undefined
+}
+```
+
+Added in v1.20.0
+
 ## Success (type alias)
 
 **Signature**
@@ -2507,7 +2541,7 @@ export declare const matchError: {
   ): <R>(fx: Fx<A, E, R>) => Fx<B | C, E2 | E3, Scope.Scope | R2 | R3 | R>
   <A, E, R, B, E2, R2, C, E3, R3>(
     fx: Fx<A, E, R>,
-    opts: core.MatchErrorOptions<E, A, B, E2, R2, C, E3, R3>
+    opts: MatchErrorOptions<E, A, B, E2, R2, C, E3, R3>
   ): Fx<B | C, E2 | E3, Scope.Scope | R | R2 | R3>
 }
 ```
@@ -2878,6 +2912,26 @@ export declare const prependAll: {
 
 Added in v1.20.0
 
+## promise
+
+**Signature**
+
+```ts
+export declare function promise<A>(f: (signal: AbortSignal) => Promise<A>)
+```
+
+Added in v2.0.0
+
+## promiseFx
+
+**Signature**
+
+```ts
+export declare function promiseFx<A, E = never, R = never>(f: (signal: AbortSignal) => Promise<Fx<A, E, R>>)
+```
+
+Added in v2.0.0
+
 ## provide
 
 **Signature**
@@ -3299,6 +3353,24 @@ export declare const switchMatchCause: {
 
 Added in v1.20.0
 
+## switchMatchCauseEffect
+
+**Signature**
+
+```ts
+export declare const switchMatchCauseEffect: {
+  <E, A, B, E2, R2, C, E3, R3>(
+    opts: MatchCauseOptionsEffect<E, A, B, E2, R2, C, E3, R3>
+  ): <R>(fx: Fx<A, E, R>) => Fx<B | C, E2 | E3, Scope.Scope | R2 | R3 | R>
+  <A, E, R, B, E2, R2, C, E3, R3>(
+    fx: Fx<A, E, R>,
+    opts: MatchCauseOptionsEffect<E, A, B, E2, R2, C, E3, R3>
+  ): Fx<B | C, E2 | E3, Scope.Scope | R | R2 | R3>
+}
+```
+
+Added in v2.0.0
+
 ## switchMatchError
 
 **Signature**
@@ -3310,13 +3382,31 @@ export declare const switchMatchError: {
   ): <R>(fx: Fx<A, E, R>) => Fx<B | C, E2 | E3, Scope.Scope | R2 | R3 | R>
   <A, E, R, B, E2, R2, C, E3, R3>(
     fx: Fx<A, E, R>,
-    opts: core.MatchErrorOptions<E, A, B, E2, R2, C, E3, R3>
+    opts: MatchErrorOptions<E, A, B, E2, R2, C, E3, R3>
   ): Fx<B | C, E2 | E3, Scope.Scope | R | R2 | R3>
 }
 ```
 
 Added in v1.20.0
 
+## switchMatchErrorEffect
+
+**Signature**
+
+```ts
+export declare const switchMatchErrorEffect: {
+  <E, A, B, E2, R2, C, E3, R3>(
+    opts: MatchErrorOptionsEffect<E, A, B, E2, R2, C, E3, R3>
+  ): <R>(fx: Fx<A, E, R>) => Fx<B | C, E2 | E3, Scope.Scope | R2 | R3 | R>
+  <A, E, R, B, E2, R2, C, E3, R3>(
+    fx: Fx<A, E, R>,
+    opts: MatchErrorOptionsEffect<E, A, B, E2, R2, C, E3, R3>
+  ): Fx<B | C, E2 | E3, Scope.Scope | R | R2 | R3>
+}
+```
+
+Added in v2.0.0
+
 ## sync
 
 **Signature**

diff --git a/docs/fx/RefSubject.ts.md b/docs/fx/RefSubject.ts.md
@@ -1022,7 +1022,7 @@ Added in v1.20.0
 **Signature**
 
 ```ts
-export declare function tagged<E, A>(
+export declare function tagged<A, E = never>(
   replay?: number
 ): {
   <const I extends C.IdentifierFactory<any>>(identifier: I): RefSubject.Tagged<C.IdentifierOf<I>, E, A>

diff --git a/docs/path/Interpolate.ts.md b/docs/path/Interpolate.ts.md
@@ -28,9 +28,8 @@ Interpolate a path with parameters
 **Signature**
 
 ```ts
-export type Interpolate<P extends string, Params extends ParamsOf<P>> = PathJoin<
-  InterpolateParts<ParseSegments<PathToSegments<P>>, Params>
->
+export type Interpolate<P extends string, Params extends ParamsOf<P>> =
+  A.Equals<[P], [string]> extends 1 ? string : PathJoin<InterpolateParts<ParseSegments<PathToSegments<P>>, Params>>
 ```
 
 Added in v1.0.0
diff --git a/docs/path/ParamsOf.ts.md b/docs/path/ParamsOf.ts.md
@@ -28,7 +28,8 @@ Extract the parameters from a path
 **Signature**
 
 ```ts
-export type ParamsOf<T extends string> = ToParams<ParseSegments<PathToSegments<T>>>
+export type ParamsOf<T extends string> =
+  A.Equals<[T], [string]> extends 1 ? {} : ToParams<ParseSegments<PathToSegments<T>>>
 ```
 
 Added in v1.0.0
diff --git a/docs/router/CurrentRoute.ts.md b/docs/router/CurrentRoute.ts.md
@@ -36,7 +36,7 @@ Added in v1.0.0
 
 ```ts
 export declare const CurrentParams: RefSubject.Filtered<
-  Readonly<Record<string, string>>,
+  Readonly<Record<string, string | readonly string[]>>,
   never,
   CurrentRoute<string> | Navigation
 >

diff --git a/docs/template/EventHandler.ts.md b/docs/template/EventHandler.ts.md
@@ -109,7 +109,7 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export declare function make<R, E, Ev extends Event>(
+export declare function make<Ev extends Event, E = never, R = never>(
   handler: (event: Ev) => Effect<unknown, E, R>,
   options?: AddEventListenerOptions
 ): EventHandler<Ev, E, R>

diff --git a/packages/path/src/Interpolate.ts b/packages/path/src/Interpolate.ts
@@ -25,7 +25,7 @@ import type { PathJoin } from "./PathJoin.js"
  * Interpolate a path with parameters
  * @since 1.0.0
  */
-export type Interpolate<P extends string, Params extends ParamsOf<P>> = A.Equals<P, string> extends 1 ? string :
+export type Interpolate<P extends string, Params extends ParamsOf<P>> = A.Equals<[P], [string]> extends 1 ? string :
   PathJoin<
     InterpolateParts<
       ParseSegments<PathToSegments<P>>,

diff --git a/packages/path/src/ParamsOf.ts b/packages/path/src/ParamsOf.ts
@@ -25,7 +25,8 @@ import type {
  * Extract the parameters from a path
  * @since 1.0.0
  */
-export type ParamsOf<T extends string> = A.Equals<T, string> extends 1 ? {} : ToParams<ParseSegments<PathToSegments<T>>>
+export type ParamsOf<T extends string> = A.Equals<[T], [string]> extends 1 ? {}
+  : ToParams<ParseSegments<PathToSegments<T>>>
 
 type ToParams<T extends ReadonlyArray<any>, Params = {}> = [
   // @ts-expect-error Type potentially infinite