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

package/src/Metric.ts

@@ -253,7 +253,7 @@ export interface Metric<in Input, out State> extends Pipeable {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 2.0.0
  */
 export interface Counter<in Input extends number | bigint> extends Metric<Input, CounterState<Input>> {}
@@ -403,7 +403,7 @@ export interface CounterState<in Input extends number | bigint> {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 2.0.0
  */
 export interface Frequency extends Metric<string, FrequencyState> {}
@@ -488,7 +488,7 @@ export interface Frequency extends Metric<string, FrequencyState> {}
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 4.0.0
  */
 export interface FrequencyState {
@@ -551,7 +551,7 @@ export interface FrequencyState {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 2.0.0
  */
 export interface Gauge<in Input extends number | bigint> extends Metric<Input, GaugeState<Input>> {}
@@ -620,7 +620,7 @@ export interface Gauge<in Input extends number | bigint> extends Metric<Input, G
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 4.0.0
  */
 export interface GaugeState<in Input extends number | bigint> {
@@ -711,7 +711,7 @@ export interface GaugeState<in Input extends number | bigint> {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 2.0.0
  */
 export interface Histogram<Input> extends Metric<Input, HistogramState> {}
@@ -798,7 +798,7 @@ export interface Histogram<Input> extends Metric<Input, HistogramState> {}
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 4.0.0
  */
 export interface HistogramState {
@@ -904,7 +904,7 @@ export interface HistogramState {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 2.0.0
  */
 export interface Summary<Input> extends Metric<Input, SummaryState> {}
@@ -986,7 +986,7 @@ export interface Summary<Input> extends Metric<Input, SummaryState> {}
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 4.0.0
  */
 export interface SummaryState {
@@ -3007,7 +3007,7 @@ export const timer = (name: string, options?: {
  * })
  * ```
  *
- * @category utils
+ * @category getters
  * @since 2.0.0
  */
 export const value = <Input, State>(
@@ -3059,7 +3059,7 @@ export const value = <Input, State>(
  * })
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 3.6.5
  */
 export const modify: {
@@ -3104,7 +3104,7 @@ export const modify: {
    * })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 3.6.5
    */
   <Input>(input: Input): <State>(self: Metric<Input, State>) => Effect<void>
@@ -3149,7 +3149,7 @@ export const modify: {
    * })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 3.6.5
    */
   <Input, State>(self: Metric<Input, State>, input: Input): Effect<void>
@@ -3195,7 +3195,7 @@ export const modify: {
    * })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 3.6.5
    */
   <Input>(input: Input) => <State>(self: Metric<Input, State>) => Effect<void>,
@@ -3240,7 +3240,7 @@ export const modify: {
    * })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 3.6.5
    */
   <Input, State>(self: Metric<Input, State>, input: Input) => Effect<void>
@@ -3300,7 +3300,7 @@ export const modify: {
  * })
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const update: {
@@ -3354,7 +3354,7 @@ export const update: {
    * })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <Input>(input: Input): <State>(self: Metric<Input, State>) => Effect<void>
@@ -3408,7 +3408,7 @@ export const update: {
    * })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <Input, State>(self: Metric<Input, State>, input: Input): Effect<void>
@@ -3463,7 +3463,7 @@ export const update: {
    * })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <Input>(input: Input) => <State>(self: Metric<Input, State>) => Effect<void>,
@@ -3517,7 +3517,7 @@ export const update: {
    * })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <Input, State>(self: Metric<Input, State>, input: Input) => Effect<void>

package/src/Option.ts

@@ -156,7 +156,7 @@ export interface None<out A> extends Pipeable, Inspectable {
  *
  * @see {@link gen} for writing generator-based `Option` code that consumes this iterator protocol
  *
- * @category Generators
+ * @category generators
  * @since 4.0.0
  */
 export interface OptionIterator<T extends Option<any>> {
@@ -278,7 +278,7 @@ export interface OptionUnifyIgnore {}
  *
  * Use to represent `Option` in higher-kinded type operations.
  *
- * @category Type Lambdas
+ * @category type lambdas
  * @since 2.0.0
  */
 export interface OptionTypeLambda extends TypeLambda {
@@ -477,7 +477,7 @@ export const isSome: <A>(self: Option<A>) => self is Some<A> = option.isSome
  *
  * @see {@link getOrElse} for unwrapping with a default
  *
- * @category Pattern matching
+ * @category pattern matching
  * @since 2.0.0
  */
 export const match: {
@@ -511,7 +511,7 @@ export const match: {
    *
    * @see {@link getOrElse} for unwrapping with a default
    *
-   * @category Pattern matching
+   * @category pattern matching
    * @since 2.0.0
    */
   <B, A, C = B>(
@@ -550,7 +550,7 @@ export const match: {
    *
    * @see {@link getOrElse} for unwrapping with a default
    *
-   * @category Pattern matching
+   * @category pattern matching
    * @since 2.0.0
    */
   <A, B, C = B>(
@@ -2955,7 +2955,7 @@ export const tap: {
  * @see {@link zipWith} to combine with a function instead of a tuple
  * @see {@link all} to combine many `Option`s
  *
- * @category Combining
+ * @category combining
  * @since 2.0.0
  */
 export const product = <A, B>(self: Option<A>, that: Option<B>): Option<[A, B]> =>
@@ -2992,7 +2992,7 @@ export const product = <A, B>(self: Option<A>, that: Option<B>): Option<[A, B]>
  * @see {@link product} for combining exactly two
  * @see {@link all} for tuples, structs, and iterables
  *
- * @category Combining
+ * @category combining
  * @since 2.0.0
  */
 export const productMany = <A>(
@@ -3054,7 +3054,7 @@ export const productMany = <A>(
  * @see {@link product} for combining exactly two
  * @see {@link productMany} for a homogeneous collection
  *
- * @category Combining
+ * @category combining
  * @since 2.0.0
  */
 // @ts-expect-error
@@ -3224,7 +3224,7 @@ export const zipWith: {
  * // Output: 3
  * ```
  *
- * @category Reducing
+ * @category reducing
  * @since 2.0.0
  */
 export const reduceCompact: {
@@ -3252,7 +3252,7 @@ export const reduceCompact: {
    * // Output: 3
    * ```
    *
-   * @category Reducing
+   * @category reducing
    * @since 2.0.0
    */
   <B, A>(b: B, f: (b: B, a: A) => B): (self: Iterable<Option<A>>) => B
@@ -3280,7 +3280,7 @@ export const reduceCompact: {
    * // Output: 3
    * ```
    *
-   * @category Reducing
+   * @category reducing
    * @since 2.0.0
    */
   <A, B>(self: Iterable<Option<A>>, b: B, f: (b: B, a: A) => B): B
@@ -3796,7 +3796,7 @@ export const filter: {
  * // Output: true
  * ```
  *
- * @category Equivalence
+ * @category instances
  * @since 4.0.0
  */
 export const makeEquivalence = <A>(isEquivalent: Equivalence.Equivalence<A>): Equivalence.Equivalence<Option<A>> =>
@@ -3832,7 +3832,7 @@ export const makeEquivalence = <A>(isEquivalent: Equivalence.Equivalence<A>): Eq
  * // Output: -1
  * ```
  *
- * @category Sorting
+ * @category sorting
  * @since 4.0.0
  */
 export const makeOrder = <A>(O: Order<A>): Order<Option<A>> =>
@@ -3866,7 +3866,7 @@ export const makeOrder = <A>(O: Order<A>): Order<Option<A>> =>
  *
  * @see {@link zipWith} for a non-lifted variant
  *
- * @category Lifting
+ * @category lifting
  * @since 2.0.0
  */
 export const lift2 = <A, B, C>(f: (a: A, b: B) => C): {
@@ -3906,7 +3906,7 @@ export const lift2 = <A, B, C>(f: (a: A, b: B) => C): {
  * @see {@link filter} to apply a predicate to an existing `Option`
  * @see {@link toRefinement} for the inverse direction
  *
- * @category Lifting
+ * @category lifting
  * @since 2.0.0
  */
 export const liftPredicate: { // Note: I intentionally avoid using the NoInfer pattern here.
@@ -3943,7 +3943,7 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
    * @see {@link filter} to apply a predicate to an existing `Option`
    * @see {@link toRefinement} for the inverse direction
    *
-   * @category Lifting
+   * @category lifting
    * @since 2.0.0
    */
   <B extends A, A = B>(predicate: Predicate<A>): (b: B) => Option<B>
@@ -3979,7 +3979,7 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
    * @see {@link filter} to apply a predicate to an existing `Option`
    * @see {@link toRefinement} for the inverse direction
    *
-   * @category Lifting
+   * @category lifting
    * @since 2.0.0
    */
   <A, B extends A>(self: A, refinement: Refinement<A, B>): Option<B>
@@ -4015,7 +4015,7 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
    * @see {@link filter} to apply a predicate to an existing `Option`
    * @see {@link toRefinement} for the inverse direction
    *
-   * @category Lifting
+   * @category lifting
    * @since 2.0.0
    */
   <B extends A, A = B>(self: B, predicate: Predicate<A>): Option<B>
@@ -4056,7 +4056,7 @@ export const liftPredicate: { // Note: I intentionally avoid using the NoInfer p
  *
  * @see {@link contains} for a version using default equality
  *
- * @category Elements
+ * @category elements
  * @since 2.0.0
  */
 export const containsWith = <A>(isEquivalent: (self: A, that: A) => boolean): {
@@ -4095,7 +4095,7 @@ export const containsWith = <A>(isEquivalent: (self: A, that: A) => boolean): {
  * @see {@link containsWith} for custom equality
  * @see {@link exists} to test with a predicate
  *
- * @category Elements
+ * @category elements
  * @since 2.0.0
  */
 export const contains: {
@@ -4130,7 +4130,7 @@ export const contains: {
    * @see {@link containsWith} for custom equality
    * @see {@link exists} to test with a predicate
    *
-   * @category Elements
+   * @category elements
    * @since 2.0.0
    */
   <A>(a: A): (self: Option<A>) => boolean
@@ -4165,7 +4165,7 @@ export const contains: {
    * @see {@link containsWith} for custom equality
    * @see {@link exists} to test with a predicate
    *
-   * @category Elements
+   * @category elements
    * @since 2.0.0
    */
   <A>(self: Option<A>, a: A): boolean
@@ -4205,7 +4205,7 @@ export const contains: {
  * @see {@link filter} to keep or discard based on a predicate
  * @see {@link contains} to test for a specific value
  *
- * @category Elements
+ * @category elements
  * @since 2.0.0
  */
 export const exists: {
@@ -4243,7 +4243,7 @@ export const exists: {
    * @see {@link filter} to keep or discard based on a predicate
    * @see {@link contains} to test for a specific value
    *
-   * @category Elements
+   * @category elements
    * @since 2.0.0
    */
   <A, B extends A>(refinement: Refinement<NoInfer<A>, B>): (self: Option<A>) => self is Option<B>
@@ -4281,7 +4281,7 @@ export const exists: {
    * @see {@link filter} to keep or discard based on a predicate
    * @see {@link contains} to test for a specific value
    *
-   * @category Elements
+   * @category elements
    * @since 2.0.0
    */
   <A>(predicate: Predicate<NoInfer<A>>): (self: Option<A>) => boolean
@@ -4319,7 +4319,7 @@ export const exists: {
    * @see {@link filter} to keep or discard based on a predicate
    * @see {@link contains} to test for a specific value
    *
-   * @category Elements
+   * @category elements
    * @since 2.0.0
    */
   <A, B extends A>(self: Option<A>, refinement: Refinement<A, B>): self is Option<B>
@@ -4357,7 +4357,7 @@ export const exists: {
    * @see {@link filter} to keep or discard based on a predicate
    * @see {@link contains} to test for a specific value
    *
-   * @category Elements
+   * @category elements
    * @since 2.0.0
    */
   <A>(self: Option<A>, predicate: Predicate<A>): boolean
@@ -4398,7 +4398,7 @@ export const exists: {
  * @see {@link bind} to add `Option` values
  * @see {@link let_ let} to add plain values
  *
- * @category Do notation
+ * @category do notation
  * @since 2.0.0
  */
 export const bindTo: {
@@ -4433,7 +4433,7 @@ export const bindTo: {
    * @see {@link bind} to add `Option` values
    * @see {@link let_ let} to add plain values
    *
-   * @category Do notation
+   * @category do notation
    * @since 2.0.0
    */
   <N extends string>(name: N): <A>(self: Option<A>) => Option<{ [K in N]: A }>
@@ -4468,7 +4468,7 @@ export const bindTo: {
    * @see {@link bind} to add `Option` values
    * @see {@link let_ let} to add plain values
    *
-   * @category Do notation
+   * @category do notation
    * @since 2.0.0
    */
   <A, N extends string>(self: Option<A>, name: N): Option<{ [K in N]: A }>
@@ -4513,7 +4513,7 @@ export {
    * @see {@link bind} to add `Option` values
    * @see {@link bindTo} to start by naming an existing `Option`
    *
-   * @category Do notation
+   * @category do notation
    * @since 2.0.0
    */
   let_ as let
@@ -4547,7 +4547,7 @@ export {
  * @see {@link let_ let} to add plain values
  * @see {@link bindTo} to start by naming an existing `Option`
  *
- * @category Do notation
+ * @category do notation
  * @since 2.0.0
  */
 export const bind: {
@@ -4579,7 +4579,7 @@ export const bind: {
    * @see {@link let_ let} to add plain values
    * @see {@link bindTo} to start by naming an existing `Option`
    *
-   * @category Do notation
+   * @category do notation
    * @since 2.0.0
    */
   <N extends string, A extends object, B>(name: Exclude<N, keyof A>, f: (a: NoInfer<A>) => Option<B>): (self: Option<A>) => Option<{ [K in N | keyof A]: K extends keyof A ? A[K] : B }>
@@ -4611,7 +4611,7 @@ export const bind: {
    * @see {@link let_ let} to add plain values
    * @see {@link bindTo} to start by naming an existing `Option`
    *
-   * @category Do notation
+   * @category do notation
    * @since 2.0.0
    */
   <A extends object, N extends string, B>(
@@ -4649,7 +4649,7 @@ export const bind: {
  * @see {@link let_ let} to add plain values
  * @see {@link bindTo} to start by naming an existing `Option`
  *
- * @category Do notation
+ * @category do notation
  * @since 2.0.0
  */
 export const Do: Option<{}> = some({})
@@ -4690,7 +4690,7 @@ export const Do: Option<{}> = some({})
  *
  * @see {@link Do} / {@link bind} for the do notation alternative
  *
- * @category Generators
+ * @category generators
  * @since 2.0.0
  */
 export const gen: Gen.Gen<OptionTypeLambda> = (...args) => {

package/src/Order.ts

@@ -1247,7 +1247,7 @@ export const isBetween = <A>(O: Order<A>): {
  * @see {@link combine} to combine two orders
  * @see {@link combineAll} to combine multiple orders
  * @see {@link Reducer} for reducing orders as a collection operation
- * @category utils
+ * @category constructors
  * @since 4.0.0
  */
 export function makeReducer<A>() {

package/src/Path.ts

@@ -274,7 +274,7 @@ export declare namespace Path {
  * const result = Effect.provide(program, customPathLayer)
  * ```
  *
- * @category tag
+ * @category services
  * @since 4.0.0
  */
 export const Path: Context.Service<Path, Path> = Context.Service("effect/Path")

package/src/Pipeable.ts

@@ -568,7 +568,7 @@ export interface Pipeable {
  * console.log(result) // 21
  * ```
  *
- * @category utils
+ * @category combinators
  * @since 2.0.0
  */
 export const pipeArguments = <A>(self: A, args: IArguments): unknown => {

package/src/Predicate.ts

@@ -220,7 +220,7 @@ export declare namespace Predicate {
    *
    * @see {@link Predicate.Any}
    * @see {@link Refinement.In}
-   * @category type-level
+   * @category utility types
    * @since 3.6.0
    */
   export type In<T extends Any> = [T] extends [Predicate<infer _A>] ? _A : never
@@ -245,7 +245,7 @@ export declare namespace Predicate {
    * ```
    *
    * @see {@link Predicate.In}
-   * @category type-level
+   * @category utility types
    * @since 3.6.0
    */
   export type Any = Predicate<any>
@@ -302,7 +302,7 @@ export declare namespace Refinement {
    *
    * @see {@link Refinement.Out}
    * @see {@link Predicate.In}
-   * @category type-level
+   * @category utility types
    * @since 3.6.0
    */
 
@@ -330,7 +330,7 @@ export declare namespace Refinement {
    * ```
    *
    * @see {@link Refinement.In}
-   * @category type-level
+   * @category utility types
    * @since 3.6.0
    */
   export type Out<T extends Any> = [T] extends [Refinement<infer _, infer _B>] ? _B : never
@@ -356,7 +356,7 @@ export declare namespace Refinement {
    *
    * @see {@link Refinement.In}
    * @see {@link Refinement.Out}
-   * @category type-level
+   * @category utility types
    * @since 3.6.0
    */
   export type Any = Refinement<any, any>

package/src/PubSub.ts

@@ -1376,7 +1376,7 @@ export const publishAll: {
  * })
  * ```
  *
- * @category subscription
+ * @category subscriptions
  * @since 2.0.0
  */
 export const subscribe = <A>(self: PubSub<A>): Effect.Effect<Subscription<A>, never, Scope.Scope> =>
@@ -1444,7 +1444,7 @@ const unsubscribe = <A>(self: Subscription<A>): Effect.Effect<void> =>
  * })
  * ```
  *
- * @category subscription
+ * @category subscriptions
  * @since 4.0.0
  */
 export const take = <A>(self: Subscription<A>): Effect.Effect<A> =>
@@ -1492,7 +1492,7 @@ export const take = <A>(self: Subscription<A>): Effect.Effect<A> =>
  * })
  * ```
  *
- * @category subscription
+ * @category subscriptions
  * @since 4.0.0
  */
 export const takeAll = <A>(self: Subscription<A>): Effect.Effect<Arr.NonEmptyArray<A>> =>
@@ -1571,7 +1571,7 @@ const pollForItem = <A>(self: Subscription<A>) => {
  * })
  * ```
  *
- * @category subscription
+ * @category subscriptions
  * @since 4.0.0
  */
 export const takeUpTo: {
@@ -1607,7 +1607,7 @@ export const takeUpTo: {
    * })
    * ```
    *
-   * @category subscription
+   * @category subscriptions
    * @since 4.0.0
    */
   (max: number): <A>(self: Subscription<A>) => Effect.Effect<Array<A>>
@@ -1643,7 +1643,7 @@ export const takeUpTo: {
    * })
    * ```
    *
-   * @category subscription
+   * @category subscriptions
    * @since 4.0.0
    */
   <A>(self: Subscription<A>, max: number): Effect.Effect<Array<A>>
@@ -1694,7 +1694,7 @@ export const takeUpTo: {
  * })
  * ```
  *
- * @category subscription
+ * @category subscriptions
  * @since 4.0.0
  */
 export const takeBetween: {
@@ -1728,7 +1728,7 @@ export const takeBetween: {
    * })
    * ```
    *
-   * @category subscription
+   * @category subscriptions
    * @since 4.0.0
    */
   (min: number, max: number): <A>(self: Subscription<A>) => Effect.Effect<Array<A>>
@@ -1762,7 +1762,7 @@ export const takeBetween: {
    * })
    * ```
    *
-   * @category subscription
+   * @category subscriptions
    * @since 4.0.0
    */
   <A>(self: Subscription<A>, min: number, max: number): Effect.Effect<Array<A>>