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

package/src/Graph.ts

@@ -2493,7 +2493,7 @@ export const neighborsDirected: {
  * }
  * ```
  *
- * @category models
+ * @category options
  * @since 3.18.0
  */
 export interface GraphVizOptions<N, E> {
@@ -2545,7 +2545,7 @@ export interface GraphVizOptions<N, E> {
  * // }
  * ```
  *
- * @category utils
+ * @category converting
  * @since 3.18.0
  */
 export const toGraphViz: {
@@ -2578,7 +2578,7 @@ export const toGraphViz: {
    * // }
    * ```
    *
-   * @category utils
+   * @category converting
    * @since 3.18.0
    */
   <N, E>(options?: GraphVizOptions<N, E>): <T extends Kind = "directed">(graph: Graph<N, E, T> | MutableGraph<N, E, T>) => string
@@ -2611,7 +2611,7 @@ export const toGraphViz: {
    * // }
    * ```
    *
-   * @category utils
+   * @category converting
    * @since 3.18.0
    */
   <N, E, T extends Kind = "directed">(
@@ -2817,7 +2817,7 @@ export type MermaidDiagramType =
  * }
  * ```
  *
- * @category models
+ * @category options
  * @since 3.18.0
  */
 export interface MermaidOptions<N, E> {
@@ -3082,7 +3082,7 @@ const formatMermaidNode = (
  * //   0 -->|"builds with"| 3
  * ```
  *
- * @category utils
+ * @category converting
  * @since 3.18.0
  */
 export const toMermaid: {
@@ -3262,7 +3262,7 @@ export const toMermaid: {
    * //   0 -->|"builds with"| 3
    * ```
    *
-   * @category utils
+   * @category converting
    * @since 3.18.0
    */
   <N, E>(options?: MermaidOptions<N, E>): <T extends Kind = "directed">(graph: Graph<N, E, T> | MutableGraph<N, E, T>) => string
@@ -3442,7 +3442,7 @@ export const toMermaid: {
    * //   0 -->|"builds with"| 3
    * ```
    *
-   * @category utils
+   * @category converting
    * @since 3.18.0
    */
   <N, E, T extends Kind = "directed">(
@@ -5263,7 +5263,7 @@ export type EdgeWalker<E> = Walker<EdgeIndex, Edge<E>>
  * console.log(indices) // [0, 1]
  * ```
  *
- * @category utils
+ * @category iterators
  * @since 3.18.0
  */
 export const indices = <T, N>(walker: Walker<T, N>): Iterable<T> => walker.visit((index, _) => index)
@@ -5287,7 +5287,7 @@ export const indices = <T, N>(walker: Walker<T, N>): Iterable<T> => walker.visit
  * console.log(values) // ["A", "B"]
  * ```
  *
- * @category utils
+ * @category iterators
  * @since 3.18.0
  */
 export const values = <T, N>(walker: Walker<T, N>): Iterable<N> => walker.visit((_, data) => data)
@@ -5311,7 +5311,7 @@ export const values = <T, N>(walker: Walker<T, N>): Iterable<N> => walker.visit(
  * console.log(entries) // [[0, "A"], [1, "B"]]
  * ```
  *
- * @category utils
+ * @category iterators
  * @since 3.18.0
  */
 export const entries = <T, N>(walker: Walker<T, N>): Iterable<[T, N]> =>

package/src/HKT.ts

@@ -235,7 +235,7 @@ export interface TypeLambda {
  * >
  * ```
  *
- * @category type utils
+ * @category utility types
  * @since 2.0.0
  */
 export type Kind<F extends TypeLambda, In, Out2, Out1, Target> = F extends {

package/src/HashMap.ts

@@ -197,7 +197,7 @@ export declare namespace HashMap {
    * console.log(getUserById("alice")) // Option.some({ name: "Alice", age: 30 })
    * ```
    *
-   * @category type-level
+   * @category utility types
    * @since 2.0.0
    */
   export type Key<T extends HashMap<any, any>> = [T] extends [HashMap<infer _K, infer _V>] ? _K : never
@@ -228,7 +228,7 @@ export declare namespace HashMap {
    * // alice has type Option<User> thanks to type extraction
    * ```
    *
-   * @category type-level
+   * @category utility types
    * @since 2.0.0
    */
   export type Value<T extends HashMap<any, any>> = [T] extends [HashMap<infer _K, infer _V>] ? _V : never
@@ -260,7 +260,7 @@ export declare namespace HashMap {
    * console.log(descriptions) // ["book: $29 (education)", "laptop: $999 (electronics)"]
    * ```
    *
-   * @category type-level
+   * @category utility types
    * @since 3.9.0
    */
   export type Entry<T extends HashMap<any, any>> = [Key<T>, Value<T>]

package/src/HashSet.ts

@@ -125,7 +125,7 @@ export declare namespace HashSet {
    * const processNumber = (n: NumberType) => n * 2
    * ```
    *
-   * @category type-level
+   * @category utility types
    * @since 4.0.0
    */
   export type Value<T> = T extends HashSet<infer V> ? V : never

package/src/Iterable.ts

@@ -332,7 +332,7 @@ export const fromRecord = <K extends string, A>(self: Readonly<Record<K, A>>): I
  * console.log(Array.from(withZ)) // ["z", "a", "b", "c"]
  * ```
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export const prepend: {
@@ -354,7 +354,7 @@ export const prepend: {
    * console.log(Array.from(withZ)) // ["z", "a", "b", "c"]
    * ```
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <B>(head: B): <A>(self: Iterable<A>) => Iterable<A | B>
@@ -376,7 +376,7 @@ export const prepend: {
    * console.log(Array.from(withZ)) // ["z", "a", "b", "c"]
    * ```
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, B>(self: Iterable<A>, head: B): Iterable<A | B>
@@ -397,7 +397,7 @@ export const prepend: {
  * )
  * ```
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export const prependAll: {
@@ -416,7 +416,7 @@ export const prependAll: {
    * )
    * ```
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <B>(that: Iterable<B>): <A>(self: Iterable<A>) => Iterable<A | B>
@@ -435,7 +435,7 @@ export const prependAll: {
    * )
    * ```
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<A | B>
@@ -482,7 +482,7 @@ export const prependAll: {
  * @see {@link prepend} for adding one element before the existing elements
  * @see {@link appendAll} for appending all elements from another iterable
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export const append: {
@@ -524,7 +524,7 @@ export const append: {
    * @see {@link prepend} for adding one element before the existing elements
    * @see {@link appendAll} for appending all elements from another iterable
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <B>(last: B): <A>(self: Iterable<A>) => Iterable<A | B>
@@ -566,7 +566,7 @@ export const append: {
    * @see {@link prepend} for adding one element before the existing elements
    * @see {@link appendAll} for appending all elements from another iterable
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, B>(self: Iterable<A>, last: B): Iterable<A | B>
@@ -615,7 +615,7 @@ export const append: {
  * @see {@link append} for appending one value instead of another iterable
  * @see {@link prependAll} for yielding another iterable before `self`
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export const appendAll: {
@@ -662,7 +662,7 @@ export const appendAll: {
    * @see {@link append} for appending one value instead of another iterable
    * @see {@link prependAll} for yielding another iterable before `self`
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <B>(that: Iterable<B>): <A>(self: Iterable<A>) => Iterable<A | B>
@@ -709,7 +709,7 @@ export const appendAll: {
    * @see {@link append} for appending one value instead of another iterable
    * @see {@link prependAll} for yielding another iterable before `self`
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<A | B>
@@ -2273,7 +2273,7 @@ export const zipWith: {
  * console.log(Array.from(css).join("")) // "color: red; font-size: 14px; margin: 10px"
  * ```
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export const intersperse: {
@@ -2319,7 +2319,7 @@ export const intersperse: {
    * console.log(Array.from(css).join("")) // "color: red; font-size: 14px; margin: 10px"
    * ```
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <B>(middle: B): <A>(self: Iterable<A>) => Iterable<A | B>
@@ -2365,7 +2365,7 @@ export const intersperse: {
    * console.log(Array.from(css).join("")) // "color: red; font-size: 14px; margin: 10px"
    * ```
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, B>(self: Iterable<A>, middle: B): Iterable<A | B>

package/src/Layer.ts

@@ -1540,7 +1540,7 @@ export const suspend = <A, E, R>(evaluate: LazyArg<Layer<A, E, R>>): Layer<A, E,
  * const unwrappedLayer = Layer.unwrap(layerEffect)
  * ```
  *
- * @category utils
+ * @category converting
  * @since 4.0.0
  */
 export const unwrap = <A, E1, R1, E, R>(
@@ -1953,7 +1953,7 @@ const provideWith = (
  *
  * @see {@link provideMerge} for retaining the dependency services
  *
- * @category utils
+ * @category providing services
  * @since 2.0.0
  */
 export const provide: {
@@ -2033,7 +2033,7 @@ export const provide: {
    *
    * @see {@link provideMerge} for retaining the dependency services
    *
-   * @category utils
+   * @category providing services
    * @since 2.0.0
    */
   <RIn, E, ROut>(that: Layer<ROut, E, RIn>): <RIn2, E2, ROut2>(self: Layer<ROut2, E2, RIn2>) => Layer<ROut2, E | E2, RIn | Exclude<RIn2, ROut>>
@@ -2113,7 +2113,7 @@ export const provide: {
    *
    * @see {@link provideMerge} for retaining the dependency services
    *
-   * @category utils
+   * @category providing services
    * @since 2.0.0
    */
   <const Layers extends [Any, ...Array<Any>]>(that: Layers): <A, E, R>(
@@ -2200,7 +2200,7 @@ export const provide: {
    *
    * @see {@link provideMerge} for retaining the dependency services
    *
-   * @category utils
+   * @category providing services
    * @since 2.0.0
    */
   <RIn2, E2, ROut2, RIn, E, ROut>(self: Layer<ROut2, E2, RIn2>, that: Layer<ROut, E, RIn>): Layer<ROut2, E | E2, RIn | Exclude<RIn2, ROut>>
@@ -2280,7 +2280,7 @@ export const provide: {
    *
    * @see {@link provideMerge} for retaining the dependency services
    *
-   * @category utils
+   * @category providing services
    * @since 2.0.0
    */
   <A, E, R, const Layers extends [Any, ...Array<Any>]>(self: Layer<A, E, R>, that: Layers): Layer<
@@ -2372,7 +2372,7 @@ export const provide: {
  *
  * @see {@link provide} for keeping dependency services private
  *
- * @category utils
+ * @category providing services
  * @since 2.0.0
  */
 export const provideMerge: {
@@ -2454,7 +2454,7 @@ export const provideMerge: {
    *
    * @see {@link provide} for keeping dependency services private
    *
-   * @category utils
+   * @category providing services
    * @since 2.0.0
    */
   <RIn, E, ROut>(that: Layer<ROut, E, RIn>): <RIn2, E2, ROut2>(self: Layer<ROut2, E2, RIn2>) => Layer<ROut | ROut2, E | E2, RIn | Exclude<RIn2, ROut>>
@@ -2536,7 +2536,7 @@ export const provideMerge: {
    *
    * @see {@link provide} for keeping dependency services private
    *
-   * @category utils
+   * @category providing services
    * @since 2.0.0
    */
   <const Layers extends [Any, ...Array<Any>]>(that: Layers): <A, E, R>(
@@ -2625,7 +2625,7 @@ export const provideMerge: {
    *
    * @see {@link provide} for keeping dependency services private
    *
-   * @category utils
+   * @category providing services
    * @since 2.0.0
    */
   <RIn2, E2, ROut2, RIn, E, ROut>(self: Layer<ROut2, E2, RIn2>, that: Layer<ROut, E, RIn>): Layer<ROut | ROut2, E | E2, RIn | Exclude<RIn2, ROut>>
@@ -2707,7 +2707,7 @@ export const provideMerge: {
    *
    * @see {@link provide} for keeping dependency services private
    *
-   * @category utils
+   * @category providing services
    * @since 2.0.0
    */
   <A, E, R, const Layers extends [Any, ...Array<Any>]>(self: Layer<A, E, R>, that: Layers): Layer<
@@ -3634,7 +3634,7 @@ export const catchCause: {
  * transformation function `f`, and replaces the old service with the
  * transformed one.
  *
- * @category utils
+ * @category providing services
  * @since 3.13.0
  */
 export const updateService: {
@@ -3653,7 +3653,7 @@ export const updateService: {
    * transformation function `f`, and replaces the old service with the
    * transformed one.
    *
-   * @category utils
+   * @category providing services
    * @since 3.13.0
    */
   <I, A>(service: Context.Key<I, A>, f: (a: Types.NoInfer<A>) => A): <A1, E1, R1>(layer: Layer<A1, E1, R1>) => Layer<A1, E1, I | R1>
@@ -3672,7 +3672,7 @@ export const updateService: {
    * transformation function `f`, and replaces the old service with the
    * transformed one.
    *
-   * @category utils
+   * @category providing services
    * @since 3.13.0
    */
   <A1, E1, R1, I, A>(
@@ -3765,7 +3765,7 @@ export const updateService: {
  * // same Counter: false
  * ```
  *
- * @category utils
+ * @category layers
  * @since 2.0.0
  */
 export const fresh = <A, E, R>(self: Layer<A, E, R>): Layer<A, E, R> =>
@@ -4224,7 +4224,7 @@ export const satisfiesServicesType =
  * @see {@link span} for creating a layer span
  * @see {@link withSpan} for wrapping layer construction in a span
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export interface SpanOptions extends Tracer.SpanOptions {

package/src/Logger.ts

@@ -171,7 +171,7 @@ export interface Logger<in Message, out Output> extends Pipeable {
  * )
  * ```
  *
- * @category models
+ * @category options
  * @since 2.0.0
  */
 export interface Options<out Message> {
@@ -295,7 +295,7 @@ export const LogToStderr: Context.Reference<boolean> = effect.LogToStderr
  * )
  * ```
  *
- * @category utils
+ * @category mapping
  * @since 2.0.0
  */
 export const map = dual<
@@ -332,7 +332,7 @@ export const map = dual<
    * )
    * ```
    *
-   * @category utils
+   * @category mapping
    * @since 2.0.0
    */
   <Output, Output2>(f: (output: Output) => Output2) => <Message>(
@@ -371,7 +371,7 @@ export const map = dual<
    * )
    * ```
    *
-   * @category utils
+   * @category mapping
    * @since 2.0.0
    */
   <Message, Output, Output2>(self: Logger<Message, Output>, f: (output: Output) => Output2) => Logger<Message, Output2>
@@ -404,7 +404,7 @@ export const map = dual<
  * )
  * ```
  *
- * @category utils
+ * @category logging
  * @since 2.0.0
  */
 export const withConsoleLog = <Message, Output>(
@@ -441,7 +441,7 @@ export const withConsoleLog = <Message, Output>(
  * )
  * ```
  *
- * @category utils
+ * @category logging
  * @since 2.0.0
  */
 export const withConsoleError = <Message, Output>(
@@ -488,7 +488,7 @@ export const withConsoleError = <Message, Output>(
  * )
  * ```
  *
- * @category utils
+ * @category logging
  * @since 3.8.0
  */
 export const withLeveledConsole = <Message, Output>(

package/src/ManagedRuntime.ts

@@ -94,7 +94,7 @@ export declare namespace ManagedRuntime {
    * Use to derive the service requirements provided by an existing
    * `ManagedRuntime` type.
    *
-   * @category type-level
+   * @category utility types
    * @since 3.4.0
    */
   export type Services<T extends ManagedRuntime<never, any>> = [T] extends [ManagedRuntime<infer R, infer _E>] ? R
@@ -107,7 +107,7 @@ export declare namespace ManagedRuntime {
    * Use to derive the layer construction error type from an existing
    * `ManagedRuntime` type.
    *
-   * @category type-level
+   * @category utility types
    * @since 3.4.0
    */
   export type Error<T extends ManagedRuntime<never, any>> = [T] extends [ManagedRuntime<infer _R, infer E>] ? E : never

package/src/Match.ts

@@ -309,7 +309,7 @@ export interface Not {
  *
  * @see {@link value} for creating a matcher from a specific value.
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export const type: <I>() => Matcher<I, Types.Without<never>, I, never, never> = internal.type
@@ -355,7 +355,7 @@ export const type: <I>() => Matcher<I, Types.Without<never>, I, never, never> =
  *
  * @see {@link type} for creating a matcher from a specific type.
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export const value: <const I>(
@@ -388,7 +388,7 @@ export const value: <const I>(
  * console.log(message) // "Success: Hello"
  * ```
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export const valueTags: {
@@ -418,7 +418,7 @@ export const valueTags: {
    * console.log(message) // "Success: Hello"
    * ```
    *
-   * @category Creating a matcher
+   * @category constructors
    * @since 4.0.0
    */
   <
@@ -453,7 +453,7 @@ export const valueTags: {
    * console.log(message) // "Success: Hello"
    * ```
    *
-   * @category Creating a matcher
+   * @category constructors
    * @since 4.0.0
    */
   <
@@ -507,7 +507,7 @@ export const valueTags: {
  * // Output: { type: "pending" }
  * ```
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export const typeTags: {
@@ -554,7 +554,7 @@ export const typeTags: {
    * // Output: { type: "pending" }
    * ```
    *
-   * @category Creating a matcher
+   * @category constructors
    * @since 4.0.0
    */
   <I, Ret>(): <
@@ -609,7 +609,7 @@ export const typeTags: {
    * // Output: { type: "pending" }
    * ```
    *
-   * @category Creating a matcher
+   * @category constructors
    * @since 4.0.0
    */
   <I>(): <
@@ -652,7 +652,7 @@ export const typeTags: {
  * )
  * ```
  *
- * @category utils
+ * @category utility types
  * @since 4.0.0
  */
 export const withReturnType: <Ret>() => <I, F, R, A, Pr, _>(
@@ -1381,7 +1381,7 @@ export const not: <
  *
  * @see {@link string} for matching any string
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const nonEmptyString: SafeRefinement<string, never> = internal.nonEmptyString
@@ -1427,7 +1427,7 @@ export const nonEmptyString: SafeRefinement<string, never> = internal.nonEmptySt
  * // Output: "Unknown status: pending"
  * ```
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const is: <
@@ -1553,7 +1553,7 @@ export const number: Predicate.Refinement<unknown, number> = Predicate.isNumber
  * @see {@link defined} for matching only non-nullish values
  * @see {@link orElse} for providing a fallback after earlier cases
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const any: SafeRefinement<unknown, any> = internal.any
@@ -1602,7 +1602,7 @@ export const any: SafeRefinement<unknown, any> = internal.any
  *
  * @see {@link any} for matching every value without excluding nullish inputs
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const defined: <A>(u: A) => u is A & {} = internal.defined
@@ -1665,7 +1665,7 @@ export {
    * @see {@link defined} for matching non-nullish values
    * @see {@link is} for matching literal values
    *
-   * @category Predicates
+   * @category predicates
    * @since 4.0.0
    */
   _undefined as undefined
@@ -1688,7 +1688,7 @@ export {
    * @see {@link defined} for matching non-nullish values
    * @see {@link is} for matching literal values
    *
-   * @category Predicates
+   * @category predicates
    * @since 4.0.0
    */
   _null as null
@@ -1914,7 +1914,7 @@ export const record: Predicate.Refinement<unknown, { [x: PropertyKey]: unknown }
  * @see {@link instanceOfUnsafe} for constructor matching without the same type-safety guarantee
  * @see {@link record} for matching broad non-null, non-array objects
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const instanceOf: <A extends abstract new(...args: any) => any>(
@@ -2003,7 +2003,7 @@ export const instanceOfUnsafe: <A extends abstract new(...args: any) => any>(
  * @see {@link result} for returning unmatched input as a `Result` failure
  * @see {@link orElseAbsurd} for finalizing when unmatched input should be impossible
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const orElse: <RA, Ret, F extends (_: RA) => Ret>(
@@ -2096,7 +2096,7 @@ export const orElseAbsurd: <I, R, RA, A, Pr, Ret>(
  * // Output: { _id: 'Result', _tag: 'Err', err: { role: 'viewer' } }
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const result: <I, F, R, A, Pr, Ret>(
@@ -2145,7 +2145,7 @@ export const result: <I, F, R, A, Pr, Ret>(
  * @see {@link result} for preserving unmatched input as a `Result` failure
  * @see {@link orElse} for replacing unmatched input with a fallback value
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const option: <I, F, R, A, Pr, Ret>(
@@ -2181,7 +2181,7 @@ export const option: <I, F, R, A, Pr, Ret>(
  * )
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const exhaustive: <I, F, A, Pr, Ret>(