effect 4.0.0-beta.72 → 4.0.0-beta.74

package/src/Result.ts

@@ -265,7 +265,7 @@ export interface ResultUnifyIgnore {}
  * (e.g., `map`, `flatMap` abstractions). You typically do not need to
  * reference this directly.
  *
- * @category Type Lambdas
+ * @category type lambdas
  * @since 4.0.0
  */
 export interface ResultTypeLambda extends TypeLambda {
@@ -745,7 +745,7 @@ export {
  *
  * @see {@link isSuccess} / {@link isFailure} to narrow to a specific variant
  *
- * @category Type Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isResult: (input: unknown) => input is Result<unknown, unknown> = result.isResult
@@ -778,7 +778,7 @@ export const isResult: (input: unknown) => input is Result<unknown, unknown> = r
  * @see {@link isSuccess} for the opposite check
  * @see {@link isResult} to check if a value is any Result
  *
- * @category Type Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isFailure: <A, E>(self: Result<A, E>) => self is Failure<A, E> = result.isFailure
@@ -811,7 +811,7 @@ export const isFailure: <A, E>(self: Result<A, E>) => self is Failure<A, E> = re
  * @see {@link isFailure} for the opposite check
  * @see {@link isResult} to check if a value is any Result
  *
- * @category Type Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isSuccess: <A, E>(self: Result<A, E>) => self is Success<A, E> = result.isSuccess
@@ -906,7 +906,7 @@ export const getFailure: <A, E>(self: Result<A, E>) => Option<E> = result.getFai
  * // Output: false
  * ```
  *
- * @category Equivalence
+ * @category instances
  * @since 4.0.0
  */
 export const makeEquivalence = <A, E>(
@@ -1292,7 +1292,7 @@ export const map: {
  * @see {@link merge} to extract `A | E` without mapping
  * @see {@link getOrElse} to unwrap only the success with a fallback
  *
- * @category Pattern Matching
+ * @category pattern matching
  * @since 2.0.0
  */
 export const match: {
@@ -1326,7 +1326,7 @@ export const match: {
    * @see {@link merge} to extract `A | E` without mapping
    * @see {@link getOrElse} to unwrap only the success with a fallback
    *
-   * @category Pattern Matching
+   * @category pattern matching
    * @since 2.0.0
    */
   <E, B, A, C = B>(
@@ -1365,7 +1365,7 @@ export const match: {
    * @see {@link merge} to extract `A | E` without mapping
    * @see {@link getOrElse} to unwrap only the success with a fallback
    *
-   * @category Pattern Matching
+   * @category pattern matching
    * @since 2.0.0
    */
   <A, E, B, C = B>(
@@ -2909,7 +2909,7 @@ export const all: <const I extends Iterable<Result<any, any>> | Record<string, R
  *
  * @see {@link mapError} to transform the error without swapping
  *
- * @category utils
+ * @category transforming
  * @since 2.0.0
  */
 export const flip = <A, E>(self: Result<A, E>): Result<E, A> =>
@@ -2948,7 +2948,7 @@ export const flip = <A, E>(self: Result<A, E>): Result<E, A> =>
  * @see {@link flatMap} for point-free sequential composition
  * @see {@link all} to collect multiple independent Results
  *
- * @category Generators
+ * @category generators
  * @since 2.0.0
  */
 export const gen: Gen.Gen<ResultTypeLambda> = (...args) => {
@@ -3004,7 +3004,7 @@ export const gen: Gen.Gen<ResultTypeLambda> = (...args) => {
  * @see {@link gen} for an alternative generator-based syntax
  * @see {@link bindTo} for starting a do-notation chain from an existing Result
  *
- * @category Do Notation
+ * @category do notation
  * @since 2.0.0
  */
 export const Do: Result<{}> = succeed({})
@@ -3042,7 +3042,7 @@ export const Do: Result<{}> = succeed({})
  * @see {@link let_ let} for pure computed fields
  * @see {@link bindTo} to wrap an initial Result into a named field
  *
- * @category Do Notation
+ * @category do notation
  * @since 2.0.0
  */
 export const bind: {
@@ -3079,7 +3079,7 @@ export const bind: {
    * @see {@link let_ let} for pure computed fields
    * @see {@link bindTo} to wrap an initial Result into a named field
    *
-   * @category Do Notation
+   * @category do notation
    * @since 2.0.0
    */
   <N extends string, A extends object, B, L2>(name: Exclude<N, keyof A>, f: (a: NoInfer<A>) => Result<B, L2>): <L1>(self: Result<A, L1>) => Result<{ [K in N | keyof A]: K extends keyof A ? A[K] : B }, L1 | L2>
@@ -3116,7 +3116,7 @@ export const bind: {
    * @see {@link let_ let} for pure computed fields
    * @see {@link bindTo} to wrap an initial Result into a named field
    *
-   * @category Do Notation
+   * @category do notation
    * @since 2.0.0
    */
   <A extends object, L1, N extends string, B, L2>(
@@ -3156,7 +3156,7 @@ export const bind: {
  * @see {@link Do} to start from an empty object
  * @see {@link bind} to add more fields
  *
- * @category Do Notation
+ * @category do notation
  * @since 2.0.0
  */
 export const bindTo: {
@@ -3190,7 +3190,7 @@ export const bindTo: {
    * @see {@link Do} to start from an empty object
    * @see {@link bind} to add more fields
    *
-   * @category Do Notation
+   * @category do notation
    * @since 2.0.0
    */
   <N extends string>(name: N): <R, L>(self: Result<R, L>) => Result<Record<N, R>, L>
@@ -3224,7 +3224,7 @@ export const bindTo: {
    * @see {@link Do} to start from an empty object
    * @see {@link bind} to add more fields
    *
-   * @category Do Notation
+   * @category do notation
    * @since 2.0.0
    */
   <R, L, N extends string>(self: Result<R, L>, name: N): Result<Record<N, R>, L>
@@ -3274,7 +3274,7 @@ export {
    * @see {@link Do} to start the do-notation chain
    * @see {@link bind} for Result-producing fields
    *
-   * @category Do Notation
+   * @category do notation
    * @since 2.0.0
    */
   let_ as let

package/src/Schedule.ts

@@ -665,7 +665,7 @@ export const toStepWithSleep = <Output, Input, Error, Env>(
  * })
  * ```
  *
- * @category utils
+ * @category delays & timeouts
  * @since 2.0.0
  */
 export const addDelay: {
@@ -765,7 +765,7 @@ export const addDelay: {
    * })
    * ```
    *
-   * @category utils
+   * @category delays & timeouts
    * @since 2.0.0
    */
   <Output, Error2 = never, Env2 = never>(f: (output: Output) => Effect<Duration.Input, Error2, Env2>): <Input, Error, Env>(
@@ -867,7 +867,7 @@ export const addDelay: {
    * })
    * ```
    *
-   * @category utils
+   * @category delays & timeouts
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Error2 = never, Env2 = never>(
@@ -1444,7 +1444,7 @@ export const andThenResult: {
  *
  * @see {@link either} for continuing while either schedule still recurs
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const both: {
@@ -1523,7 +1523,7 @@ export const both: {
    *
    * @see {@link either} for continuing while either schedule still recurs
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <Output2, Input2, Error2, Env2, Output>(other: Schedule<Output2, Input2, Error2, Env2>): <Input, Error, Env>(
@@ -1604,7 +1604,7 @@ export const both: {
    *
    * @see {@link either} for continuing while either schedule still recurs
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
@@ -1646,7 +1646,7 @@ export const both: {
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const bothLeft: {
@@ -1679,7 +1679,7 @@ export const bothLeft: {
    * })
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(
@@ -1714,7 +1714,7 @@ export const bothLeft: {
    * })
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
@@ -1757,7 +1757,7 @@ export const bothLeft: {
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const bothRight: {
@@ -1792,7 +1792,7 @@ export const bothRight: {
    * })
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(
@@ -1829,7 +1829,7 @@ export const bothRight: {
    * })
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
@@ -1877,7 +1877,7 @@ export const bothRight: {
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const bothWith: {
@@ -1917,7 +1917,7 @@ export const bothWith: {
    * })
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <Output2, Input2, Error2, Env2, Output, Output3>(
@@ -1962,7 +1962,7 @@ export const bothWith: {
    * })
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2, Output3>(
@@ -2030,7 +2030,7 @@ export const bothWith: {
  * })
  * ```
  *
- * @category utils
+ * @category collecting
  * @since 4.0.0
  */
 export const collectInputs = <Output, Input, Error, Env>(
@@ -2067,7 +2067,7 @@ export const collectInputs = <Output, Input, Error, Env>(
  * })
  * ```
  *
- * @category utils
+ * @category collecting
  * @since 4.0.0
  */
 export const collectOutputs = <Output, Input, Error, Env>(
@@ -2154,7 +2154,7 @@ export const collectOutputs = <Output, Input, Error, Env>(
  * })
  * ```
  *
- * @category utils
+ * @category collecting
  * @since 2.0.0
  */
 export const collectWhile: {
@@ -2238,7 +2238,7 @@ export const collectWhile: {
    * })
    * ```
    *
-   * @category utils
+   * @category collecting
    * @since 2.0.0
    */
   <Input, Output, Error2 = never, Env2 = never>(
@@ -2328,7 +2328,7 @@ export const collectWhile: {
    * })
    * ```
    *
-   * @category utils
+   * @category collecting
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Error2 = never, Env2 = never>(
@@ -3062,7 +3062,7 @@ export const during = (duration: Duration.Input): Schedule<Duration.Duration> =>
  *
  * @see {@link both} for continuing only while both schedules still recur
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const either: {
@@ -3142,7 +3142,7 @@ export const either: {
    *
    * @see {@link both} for continuing only while both schedules still recur
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(
@@ -3224,7 +3224,7 @@ export const either: {
    *
    * @see {@link both} for continuing only while both schedules still recur
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
@@ -3269,7 +3269,7 @@ export const either: {
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 4.0.0
  */
 export const eitherLeft: {
@@ -3305,7 +3305,7 @@ export const eitherLeft: {
    * })
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 4.0.0
    */
   <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(
@@ -3343,7 +3343,7 @@ export const eitherLeft: {
    * })
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 4.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
@@ -3387,7 +3387,7 @@ export const eitherLeft: {
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 4.0.0
  */
 export const eitherRight: {
@@ -3423,7 +3423,7 @@ export const eitherRight: {
    * })
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 4.0.0
    */
   <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(
@@ -3461,7 +3461,7 @@ export const eitherRight: {
    * })
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 4.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(
@@ -3510,7 +3510,7 @@ export const eitherRight: {
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const eitherWith: {
@@ -3551,7 +3551,7 @@ export const eitherWith: {
    * })
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <Output2, Input2, Error2, Env2, Output, Output3>(
@@ -3597,7 +3597,7 @@ export const eitherWith: {
    * })
    * ```
    *
-   * @category utils
+   * @category combining
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Output2, Input2, Error2, Env2, Output3>(
@@ -3660,7 +3660,7 @@ export const eitherWith: {
                * })
                * ```
                *
-               * @category utils
+               * @category combining
                * @since 2.0.0
                */
               [Output3, Duration.Duration]>([
@@ -4200,7 +4200,7 @@ export const map: {
  * })
  * ```
  *
- * @category utils
+ * @category delays & timeouts
  * @since 2.0.0
  */
 export const modifyDelay: {
@@ -4234,7 +4234,7 @@ export const modifyDelay: {
    * })
    * ```
    *
-   * @category utils
+   * @category delays & timeouts
    * @since 2.0.0
    */
   <Output, Error2 = never, Env2 = never>(
@@ -4275,7 +4275,7 @@ export const modifyDelay: {
    * })
    * ```
    *
-   * @category utils
+   * @category delays & timeouts
    * @since 2.0.0
    */
   <Output, Input, Error, Env, Error2 = never, Env2 = never>(
@@ -4312,7 +4312,7 @@ export const modifyDelay: {
  *
  * @see {@link modifyDelay} for replacing recurrence delays with a custom effectful transformation
  *
- * @category utils
+ * @category delays & timeouts
  * @since 2.0.0
  */
 export const jittered = <Output, Input, Error, Env>(
@@ -4350,7 +4350,7 @@ export const jittered = <Output, Input, Error, Env>(
  * })
  * ```
  *
- * @category utils
+ * @category mapping
  * @since 2.0.0
  */
 export const passthrough = <Output, Input, Error, Env>(
@@ -4546,7 +4546,7 @@ export const recurs = (times: number): Schedule<number> =>
  * })
  * ```
  *
- * @category utils
+ * @category folding
  * @since 2.0.0
  */
 export const reduce: {
@@ -4659,7 +4659,7 @@ export const reduce: {
    * })
    * ```
    *
-   * @category utils
+   * @category folding
    * @since 2.0.0
    */
   <State, Output, Error2 = never, Env2 = never>(
@@ -4777,7 +4777,7 @@ export const reduce: {
    * })
    * ```
    *
-   * @category utils
+   * @category folding
    * @since 2.0.0
    */
   <Output, Input, Error, Env, State, Error2 = never, Env2 = never>(
@@ -5758,7 +5758,7 @@ export const tapOutput: {
  *
  * @see {@link recurs} for creating a count-limited schedule
  *
- * @category utils
+ * @category taking
  * @since 4.0.0
  */
 export const take: {
@@ -5854,7 +5854,7 @@ export const take: {
    *
    * @see {@link recurs} for creating a count-limited schedule
    *
-   * @category utils
+   * @category taking
    * @since 4.0.0
    */
   (n: number): <Output, Input, Error, Env>(
@@ -5952,7 +5952,7 @@ export const take: {
    *
    * @see {@link recurs} for creating a count-limited schedule
    *
-   * @category utils
+   * @category taking
    * @since 4.0.0
    */
   <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>, n: number): Schedule<Output, Input, Error, Env>
@@ -6124,7 +6124,7 @@ export {
    * @see {@link collectWhile} for collecting outputs while using the same predicate
    * @see {@link take} for stopping after a fixed number of schedule outputs
    *
-   * @category utils
+   * @category filtering
    * @since 4.0.0
    */
   while_ as while