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

package/src/Queue.ts

@@ -891,7 +891,7 @@ export const offerAllUnsafe = <A, E>(self: Enqueue<A, E>, messages: Iterable<A>)
  * })
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const fail = <A, E>(self: Enqueue<A, E>, error: E) => failCause(self, core.causeFail(error))
@@ -918,7 +918,7 @@ export const fail = <A, E>(self: Enqueue<A, E>, error: E) => failCause(self, cor
  * })
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const failCause: {
@@ -944,7 +944,7 @@ export const failCause: {
    * })
    * ```
    *
-   * @category Completion
+   * @category completion
    * @since 4.0.0
    */
   <E>(cause: Cause<E>): <A>(self: Enqueue<A, E>) => Effect<boolean>
@@ -970,7 +970,7 @@ export const failCause: {
    * })
    * ```
    *
-   * @category Completion
+   * @category completion
    * @since 4.0.0
    */
   <A, E>(self: Enqueue<A, E>, cause: Cause<E>): Effect<boolean>
@@ -1006,7 +1006,7 @@ export const failCause: {
  * })
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const failCauseUnsafe = <A, E>(self: Enqueue<A, E>, cause: Cause<E>): boolean => {
@@ -1064,7 +1064,7 @@ export const failCauseUnsafe = <A, E>(self: Enqueue<A, E>, cause: Cause<E>): boo
  * })
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const end = <A, E>(self: Enqueue<A, E | Done>): Effect<boolean> => failCause(self, core.causeFail(core.Done()))
@@ -1113,7 +1113,7 @@ export const end = <A, E>(self: Enqueue<A, E | Done>): Effect<boolean> => failCa
  * })
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const endUnsafe = <A, E>(self: Enqueue<A, E | Done>) => failCauseUnsafe(self, core.causeFail(core.Done()))
@@ -1159,7 +1159,7 @@ export const endUnsafe = <A, E>(self: Enqueue<A, E | Done>) => failCauseUnsafe(s
  * })
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const interrupt = <A, E>(self: Enqueue<A, E>): Effect<boolean> =>
@@ -1196,7 +1196,7 @@ export const interrupt = <A, E>(self: Enqueue<A, E>): Effect<boolean> =>
  * })
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 2.0.0
  */
 export const shutdown = <A, E>(self: Enqueue<A, E>): Effect<boolean> =>
@@ -1295,7 +1295,7 @@ export const clear = <A, E>(self: Dequeue<A, E>): Effect<Array<A>, Pull.ExcludeD
  * })
  * ```
  *
- * @category Taking
+ * @category taking
  * @since 2.0.0
  */
 export const takeAll = <A, E>(self: Dequeue<A, E>): Effect<Arr.NonEmptyArray<A>, E> =>
@@ -1323,7 +1323,7 @@ export const takeAll = <A, E>(self: Dequeue<A, E>): Effect<Arr.NonEmptyArray<A>,
  * })
  * ```
  *
- * @category Taking
+ * @category taking
  * @since 4.0.0
  */
 export const collect = <A, E>(self: Dequeue<A, E | Done>): Effect<Array<A>, Pull.ExcludeDone<E>> =>
@@ -1381,7 +1381,7 @@ export const collect = <A, E>(self: Dequeue<A, E | Done>): Effect<Array<A>, Pull
  * })
  * ```
  *
- * @category Taking
+ * @category taking
  * @since 2.0.0
  */
 export const takeN = <A, E>(
@@ -1423,7 +1423,7 @@ export const takeN = <A, E>(
  * })
  * ```
  *
- * @category Taking
+ * @category taking
  * @since 2.0.0
  */
 export const takeBetween = <A, E>(
@@ -1473,7 +1473,7 @@ export const takeBetween = <A, E>(
  * })
  * ```
  *
- * @category Taking
+ * @category taking
  * @since 2.0.0
  */
 export const take = <A, E>(self: Dequeue<A, E>): Effect<A, E> =>
@@ -1511,7 +1511,7 @@ export const take = <A, E>(self: Dequeue<A, E>): Effect<A, E> =>
  * })
  * ```
  *
- * @category Taking
+ * @category taking
  * @since 2.0.0
  */
 export const poll = <A, E>(self: Dequeue<A, E>): Effect<Option.Option<A>> =>
@@ -1597,7 +1597,7 @@ export const peek = <A, E>(self: Dequeue<A, E>): Effect<A, E> =>
  * })
  * ```
  *
- * @category Taking
+ * @category taking
  * @since 4.0.0
  */
 export const takeUnsafe = <A, E>(self: Dequeue<A, E>): Exit<A, E> | undefined => {
@@ -1661,7 +1661,7 @@ export {
    * @see {@link interrupt} for graceful interruption after buffered messages are drained
    * @see {@link shutdown} for immediately discarding buffered messages and resuming pending operations
    *
-   * @category Completion
+   * @category completion
    * @since 4.0.0
    */
   await_ as await
@@ -1702,7 +1702,7 @@ export {
  * })
  * ```
  *
- * @category Size
+ * @category sizes
  * @since 2.0.0
  */
 export const size = <A, E>(self: Dequeue<A, E>): Effect<number> => internalEffect.sync(() => sizeUnsafe(self))
@@ -1727,7 +1727,7 @@ export const size = <A, E>(self: Dequeue<A, E>): Effect<number> => internalEffec
  * })
  * ```
  *
- * @category Size
+ * @category sizes
  * @since 2.0.0
  */
 export const isFull = <A, E>(self: Dequeue<A, E>): Effect<boolean> => internalEffect.sync(() => isFullUnsafe(self))
@@ -1770,7 +1770,7 @@ export const isFull = <A, E>(self: Dequeue<A, E>): Effect<boolean> => internalEf
  * })
  * ```
  *
- * @category Size
+ * @category sizes
  * @since 4.0.0
  */
 export const sizeUnsafe = <A, E>(self: Dequeue<A, E>): number => self.state._tag === "Done" ? 0 : self.messages.length
@@ -1795,7 +1795,7 @@ export const sizeUnsafe = <A, E>(self: Dequeue<A, E>): number => self.state._tag
  * })
  * ```
  *
- * @category Size
+ * @category sizes
  * @since 4.0.0
  */
 export const isFullUnsafe = <A, E>(self: Dequeue<A, E>): boolean => sizeUnsafe(self) === self.capacity
@@ -1831,7 +1831,7 @@ export const isFullUnsafe = <A, E>(self: Dequeue<A, E>): boolean => sizeUnsafe(s
  * })
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const into: {
@@ -1866,7 +1866,7 @@ export const into: {
    * })
    * ```
    *
-   * @category Completion
+   * @category completion
    * @since 4.0.0
    */
   <A, E>(self: Enqueue<A, E | Done>): <AX, EX extends E, RX>(
@@ -1903,7 +1903,7 @@ export const into: {
    * })
    * ```
    *
-   * @category Completion
+   * @category completion
    * @since 4.0.0
    */
   <AX, E, EX extends E, RX, A>(effect: Effect<AX, EX, RX>, self: Enqueue<A, E | Done>): Effect<boolean, never, RX>

package/src/Record.ts

@@ -661,7 +661,7 @@ export const get: {
  * Record.modify(input, "b", f) // Option.none()
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const modify: {
@@ -682,7 +682,7 @@ export const modify: {
    * Record.modify(input, "b", f) // Option.none()
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <K extends string | symbol, A, B>(key: NoInfer<K>, f: (a: A) => B): (self: ReadonlyRecord<K, A>) => Option.Option<Record<K, A | B>>
@@ -703,7 +703,7 @@ export const modify: {
    * Record.modify(input, "b", f) // Option.none()
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <K extends string | symbol, A, B>(self: ReadonlyRecord<K, A>, key: NoInfer<K>, f: (a: A) => B): Option.Option<Record<K, A | B>>
@@ -737,7 +737,7 @@ export const modify: {
  * Record.replace(Record.empty<string>(), "a", 10) // Option.none()
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const replace: {
@@ -759,7 +759,7 @@ export const replace: {
    * Record.replace(Record.empty<string>(), "a", 10) // Option.none()
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <K extends string | symbol, B>(key: NoInfer<K>, b: B): <A>(self: ReadonlyRecord<K, A>) => Option.Option<Record<K, A | B>>
@@ -781,7 +781,7 @@ export const replace: {
    * Record.replace(Record.empty<string>(), "a", 10) // Option.none()
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <K extends string | symbol, A, B>(self: ReadonlyRecord<K, A>, key: NoInfer<K>, b: B): Option.Option<Record<K, A | B>>
@@ -815,7 +815,7 @@ export const replace: {
  * assert.deepStrictEqual(Record.remove({ a: 1, b: 2 }, "a"), { b: 2 })
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const remove: {
@@ -840,7 +840,7 @@ export const remove: {
    * assert.deepStrictEqual(Record.remove({ a: 1, b: 2 }, "a"), { b: 2 })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <K extends string | symbol, X extends K>(key: X): <A>(self: ReadonlyRecord<K, A>) => Record<Exclude<K, X>, A>
@@ -865,7 +865,7 @@ export const remove: {
    * assert.deepStrictEqual(Record.remove({ a: 1, b: 2 }, "a"), { b: 2 })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <K extends string | symbol, A, X extends K>(self: ReadonlyRecord<K, A>, key: X): Record<Exclude<K, X>, A>
@@ -897,7 +897,7 @@ export const remove: {
  * Record.pop(input, "c") // Option.none()
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const pop: {
@@ -917,7 +917,7 @@ export const pop: {
    * Record.pop(input, "c") // Option.none()
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <K extends string | symbol, X extends K>(key: X): <A>(self: ReadonlyRecord<K, A>) => Option.Option<[A, Record<Exclude<K, X>, A>]>
@@ -937,7 +937,7 @@ export const pop: {
    * Record.pop(input, "c") // Option.none()
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <K extends string | symbol, A, X extends K>(self: ReadonlyRecord<K, A>, key: X): Option.Option<[A, Record<Exclude<K, X>, A>]>
@@ -1616,7 +1616,7 @@ export const values = <K extends string, A>(self: ReadonlyRecord<K, A>): Array<A
  * assert.deepStrictEqual(Record.set("c", 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 })
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const set: {
@@ -1633,7 +1633,7 @@ export const set: {
    * assert.deepStrictEqual(Record.set("c", 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <K extends string | symbol, K1 extends K | ((string | symbol) & {}), B>(key: K1, value: B): <A>(self: ReadonlyRecord<K, A>) => Record<K | K1, A | B>
@@ -1650,7 +1650,7 @@ export const set: {
    * assert.deepStrictEqual(Record.set("c", 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <K extends string | symbol, A, K1 extends K | ((string | symbol) & {}), B>(self: ReadonlyRecord<K, A>, key: K1, value: B): Record<K | K1, A | B>

package/src/Redacted.ts

@@ -155,7 +155,7 @@ export declare namespace Redacted {
    * console.log(rotate({ token: "secret" })) // { token: "secret:rotated" }
    * ```
    *
-   * @category type-level
+   * @category utility types
    * @since 3.3.0
    */
   export type Value<T extends Redacted<any>> = [T] extends [Redacted<infer _A>] ? _A : never
@@ -340,7 +340,7 @@ export const wipeUnsafe = <T>(self: Redacted<T>): boolean => redacted.redactedRe
  * assert.equal(equivalence(API_KEY1, API_KEY3), true)
  * ```
  *
- * @category equivalence
+ * @category instances
  * @since 4.0.0
  */
 export const makeEquivalence = <A>(isEquivalent: Equivalence.Equivalence<A>): Equivalence.Equivalence<Redacted<A>> =>

package/src/Ref.ts

@@ -386,7 +386,7 @@ export const set = dual<
  * @see {@link set} for setting without returning the previous value
  * @see {@link getAndUpdate} for deriving the new value from the previous value
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const getAndSet = dual<
@@ -417,7 +417,7 @@ export const getAndSet = dual<
    * @see {@link set} for setting without returning the previous value
    * @see {@link getAndUpdate} for deriving the new value from the previous value
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <A>(value: A) => (self: Ref<A>) => Effect.Effect<A>,
@@ -448,7 +448,7 @@ export const getAndSet = dual<
    * @see {@link set} for setting without returning the previous value
    * @see {@link getAndUpdate} for deriving the new value from the previous value
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <A>(self: Ref<A>, value: A) => Effect.Effect<A>
@@ -486,7 +486,7 @@ export const getAndSet = dual<
  * @see {@link update} for updating without returning the previous value
  * @see {@link updateAndGet} for returning the new value instead
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const getAndUpdate = dual<
@@ -517,7 +517,7 @@ export const getAndUpdate = dual<
    * @see {@link update} for updating without returning the previous value
    * @see {@link updateAndGet} for returning the new value instead
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <A>(f: (a: A) => A) => (self: Ref<A>) => Effect.Effect<A>,
@@ -548,7 +548,7 @@ export const getAndUpdate = dual<
    * @see {@link update} for updating without returning the previous value
    * @see {@link updateAndGet} for returning the new value instead
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <A>(self: Ref<A>, f: (a: A) => A) => Effect.Effect<A>
@@ -605,7 +605,7 @@ export const getAndUpdate = dual<
  * @see {@link getAndUpdate} for always applying an update
  * @see {@link updateSome} for conditional updates without returning the previous value
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const getAndUpdateSome = dual<
@@ -655,7 +655,7 @@ export const getAndUpdateSome = dual<
    * @see {@link getAndUpdate} for always applying an update
    * @see {@link updateSome} for conditional updates without returning the previous value
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <A>(pf: (a: A) => Option.Option<A>) => (self: Ref<A>) => Effect.Effect<A>,
@@ -705,7 +705,7 @@ export const getAndUpdateSome = dual<
    * @see {@link getAndUpdate} for always applying an update
    * @see {@link updateSome} for conditional updates without returning the previous value
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <A>(self: Ref<A>, pf: (a: A) => Option.Option<A>) => Effect.Effect<A>
@@ -753,7 +753,7 @@ export const getAndUpdateSome = dual<
  * })
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const setAndGet = dual<
@@ -791,7 +791,7 @@ export const setAndGet = dual<
    * })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <A>(value: A) => (self: Ref<A>) => Effect.Effect<A>,
@@ -829,7 +829,7 @@ export const setAndGet = dual<
    * })
    * ```
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <A>(self: Ref<A>, value: A) => Effect.Effect<A>
@@ -1453,7 +1453,7 @@ export const update = dual<
  * @see {@link update} for updating without returning the new value
  * @see {@link getAndUpdate} for returning the previous value instead
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const updateAndGet = dual<
@@ -1485,7 +1485,7 @@ export const updateAndGet = dual<
    * @see {@link update} for updating without returning the new value
    * @see {@link getAndUpdate} for returning the previous value instead
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <A>(f: (a: A) => A) => (self: Ref<A>) => Effect.Effect<A>,
@@ -1517,7 +1517,7 @@ export const updateAndGet = dual<
    * @see {@link update} for updating without returning the new value
    * @see {@link getAndUpdate} for returning the previous value instead
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <A>(self: Ref<A>, f: (a: A) => A) => Effect.Effect<A>
@@ -1715,7 +1715,7 @@ export const updateSome = dual<
  * @see {@link updateSome} for conditional updates without returning a value
  * @see {@link updateAndGet} for always updating and returning the new value
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const updateSomeAndGet = dual<
@@ -1759,7 +1759,7 @@ export const updateSomeAndGet = dual<
    * @see {@link updateSome} for conditional updates without returning a value
    * @see {@link updateAndGet} for always updating and returning the new value
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <A>(pf: (a: A) => Option.Option<A>) => (self: Ref<A>) => Effect.Effect<A>,
@@ -1803,7 +1803,7 @@ export const updateSomeAndGet = dual<
    * @see {@link updateSome} for conditional updates without returning a value
    * @see {@link updateAndGet} for always updating and returning the new value
    *
-   * @category utils
+   * @category mutations
    * @since 2.0.0
    */
   <A>(self: Ref<A>, pf: (a: A) => Option.Option<A>) => Effect.Effect<A>

package/src/RegExp.ts

@@ -102,7 +102,7 @@ export const isRegExp: (input: unknown) => input is RegExp = predicate.isRegExp
  * assert.deepStrictEqual(RegExp.escape("a*b"), "a\\*b")
  * ```
  *
- * @category utils
+ * @category RegExp
  * @since 2.0.0
  */
 export const escape = (string: string): string => string.replace(/[/\\^$*+?.()|[\]{}]/g, "\\$&")

package/src/Request.ts

@@ -169,7 +169,7 @@ export interface Constructor<R extends Request<any, any, any>, T extends keyof R
  * type UserError = Request.Error<GetUser> // Error
  * ```
  *
- * @category type-level
+ * @category utility types
  * @since 2.0.0
  */
 export type Error<T extends Request<any, any, any>> = [T] extends [Request<infer _A, infer _E, infer _R>] ? _E : never
@@ -191,7 +191,7 @@ export type Error<T extends Request<any, any, any>> = [T] extends [Request<infer
  * type UserSuccess = Request.Success<GetUser> // string
  * ```
  *
- * @category type-level
+ * @category utility types
  * @since 2.0.0
  */
 export type Success<T extends Request<any, any, any>> = [T] extends [Request<infer _A, infer _E, infer _R>] ? _A
@@ -200,7 +200,7 @@ export type Success<T extends Request<any, any, any>> = [T] extends [Request<inf
 /**
  * A utility type to extract the requirements type from a `Request`.
  *
- * @category type-level
+ * @category utility types
  * @since 4.0.0
  */
 export type Services<T extends Request<any, any, any>> = [T] extends [Request<infer _A, infer _E, infer _R>] ? _R
@@ -223,7 +223,7 @@ export type Services<T extends Request<any, any, any>> = [T] extends [Request<in
  * type UserResult = Request.Result<GetUser> // Exit.Exit<string, Error>
  * ```
  *
- * @category type-level
+ * @category utility types
  * @since 2.0.0
  */
 export type Result<T extends Request<any, any, any>> = T extends Request<infer A, infer E, infer _R> ? Exit.Exit<A, E>

package/src/RequestResolver.ts

@@ -1595,7 +1595,7 @@ export const withSpan: {
  * @see {@link persisted} for storing persistable request results outside process memory
  * @see {@link Cache.Cache} for operations available on the returned cache
  *
- * @category Caching
+ * @category caching
  * @since 4.0.0
  */
 export const asCache: {
@@ -1623,7 +1623,7 @@ export const asCache: {
    * @see {@link persisted} for storing persistable request results outside process memory
    * @see {@link Cache.Cache} for operations available on the returned cache
    *
-   * @category Caching
+   * @category caching
    * @since 4.0.0
    */
   <
@@ -1669,7 +1669,7 @@ export const asCache: {
    * @see {@link persisted} for storing persistable request results outside process memory
    * @see {@link Cache.Cache} for operations available on the returned cache
    *
-   * @category Caching
+   * @category caching
    * @since 4.0.0
    */
   <
@@ -1738,7 +1738,7 @@ export const asCache: {
  * @see {@link asCache} for exposing the resolver as a `Cache` with time-to-live and service lookup controls
  * @see {@link persisted} for backing persistable requests with the configured persistence store
  *
- * @category Caching
+ * @category caching
  * @since 4.0.0
  */
 export const withCache: {
@@ -1765,7 +1765,7 @@ export const withCache: {
    * @see {@link asCache} for exposing the resolver as a `Cache` with time-to-live and service lookup controls
    * @see {@link persisted} for backing persistable requests with the configured persistence store
    *
-   * @category Caching
+   * @category caching
    * @since 4.0.0
    */
   <A extends Request.Any>(
@@ -1797,7 +1797,7 @@ export const withCache: {
    * @see {@link asCache} for exposing the resolver as a `Cache` with time-to-live and service lookup controls
    * @see {@link persisted} for backing persistable requests with the configured persistence store
    *
-   * @category Caching
+   * @category caching
    * @since 4.0.0
    */
   <A extends Request.Any>(
@@ -1836,7 +1836,7 @@ export const withCache: {
      * @see {@link asCache} for exposing the resolver as a `Cache` with time-to-live and service lookup controls
      * @see {@link persisted} for backing persistable requests with the configured persistence store
      *
-     * @category Caching
+     * @category caching
      * @since 4.0.0
      */
     A, /**
@@ -1862,7 +1862,7 @@ export const withCache: {
      * @see {@link asCache} for exposing the resolver as a `Cache` with time-to-live and service lookup controls
      * @see {@link persisted} for backing persistable requests with the configured persistence store
      *
-     * @category Caching
+     * @category caching
      * @since 4.0.0
      */
     {

package/src/Resource.ts

@@ -202,7 +202,7 @@ export const get = <A, E>(self: Resource<A, E>): Effect.Effect<A, E> =>
  * @see {@link manual} for resources refreshed only by caller action
  * @see {@link auto} for schedule-driven automatic refreshes
  *
- * @category utils
+ * @category resource management
  * @since 2.0.0
  */
 export const refresh = <A, E>(self: Resource<A, E>): Effect.Effect<void, E> =>