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

package/src/Chunk.ts

@@ -225,7 +225,7 @@ const emptyArray: ReadonlyArray<never> = []
  * console.log(eq(chunk1, chunk3)) // false
  * ```
  *
- * @category equivalence
+ * @category instances
  * @since 4.0.0
  */
 export const makeEquivalence = <A>(isEquivalent: Equivalence.Equivalence<A>): Equivalence.Equivalence<Chunk<A>> =>
@@ -849,7 +849,7 @@ export const getUnsafe: {
  * @see {@link prepend} for adding one element before the existing elements
  * @see {@link appendAll} for appending all elements from another chunk
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export const append: {
@@ -879,7 +879,7 @@ export const append: {
    * @see {@link prepend} for adding one element before the existing elements
    * @see {@link appendAll} for appending all elements from another chunk
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A2>(a: A2): <A>(self: Chunk<A>) => NonEmptyChunk<A2 | A>
@@ -909,7 +909,7 @@ export const append: {
    * @see {@link prepend} for adding one element before the existing elements
    * @see {@link appendAll} for appending all elements from another chunk
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, A2>(self: Chunk<A>, a: A2): NonEmptyChunk<A | A2>
@@ -933,7 +933,7 @@ export const append: {
  * console.log(Chunk.toArray(singleElement)) // ["first"]
  * ```
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export const prepend: {
@@ -955,7 +955,7 @@ export const prepend: {
    * console.log(Chunk.toArray(singleElement)) // ["first"]
    * ```
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <B>(elem: B): <A>(self: Chunk<A>) => NonEmptyChunk<B | A>
@@ -977,7 +977,7 @@ export const prepend: {
    * console.log(Chunk.toArray(singleElement)) // ["first"]
    * ```
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, B>(self: Chunk<A>, elem: B): NonEmptyChunk<A | B>
@@ -1292,7 +1292,7 @@ export const dropWhile: {
  * // [ "a", "b", 1, 2 ]
  * ```
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export const prependAll: {
@@ -1314,7 +1314,7 @@ export const prependAll: {
    * // [ "a", "b", 1, 2 ]
    * ```
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <S extends Chunk<any>, T extends Chunk<any>>(that: T): (self: S) => Chunk.OrNonEmpty<S, T, Chunk.Infer<S> | Chunk.Infer<T>>
@@ -1336,7 +1336,7 @@ export const prependAll: {
    * // [ "a", "b", 1, 2 ]
    * ```
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, B>(self: Chunk<A>, that: NonEmptyChunk<B>): NonEmptyChunk<A | B>
@@ -1358,7 +1358,7 @@ export const prependAll: {
    * // [ "a", "b", 1, 2 ]
    * ```
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, B>(self: NonEmptyChunk<A>, that: Chunk<B>): NonEmptyChunk<A | B>
@@ -1380,7 +1380,7 @@ export const prependAll: {
    * // [ "a", "b", 1, 2 ]
    * ```
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, B>(self: Chunk<A>, that: Chunk<B>): Chunk<A | B>
@@ -1412,7 +1412,7 @@ export const prependAll: {
  * @see {@link prependAll} for concatenating chunks in the opposite order
  * @see {@link append} for adding a single element to the end
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export const appendAll: {
@@ -1442,7 +1442,7 @@ export const appendAll: {
    * @see {@link prependAll} for concatenating chunks in the opposite order
    * @see {@link append} for adding a single element to the end
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <S extends Chunk<any>, T extends Chunk<any>>(that: T): (self: S) => Chunk.OrNonEmpty<S, T, Chunk.Infer<S> | Chunk.Infer<T>>
@@ -1472,7 +1472,7 @@ export const appendAll: {
    * @see {@link prependAll} for concatenating chunks in the opposite order
    * @see {@link append} for adding a single element to the end
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, B>(self: Chunk<A>, that: NonEmptyChunk<B>): NonEmptyChunk<A | B>
@@ -1502,7 +1502,7 @@ export const appendAll: {
    * @see {@link prependAll} for concatenating chunks in the opposite order
    * @see {@link append} for adding a single element to the end
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, B>(self: NonEmptyChunk<A>, that: Chunk<B>): NonEmptyChunk<A | B>
@@ -1532,7 +1532,7 @@ export const appendAll: {
    * @see {@link prependAll} for concatenating chunks in the opposite order
    * @see {@link append} for adding a single element to the end
    *
-   * @category concatenating
+   * @category combining
    * @since 2.0.0
    */
   <A, B>(self: Chunk<A>, that: Chunk<B>): Chunk<A | B>
@@ -1571,7 +1571,7 @@ export const appendAll: {
      * @see {@link prependAll} for concatenating chunks in the opposite order
      * @see {@link append} for adding a single element to the end
      *
-     * @category concatenating
+     * @category combining
      * @since 2.0.0
      */
     A | B>({ _tag: "IConcat", left: self, right: that });

package/src/Context.ts

@@ -2000,7 +2000,7 @@ export const omit = <S extends ReadonlyArray<Key<any, any>>>(
  * @see {@link pick} for keeping selected services
  * @see {@link omit} for removing selected services
  *
- * @category utils
+ * @category mutations
  * @since 4.0.0
  */
 export const mutate: {
@@ -2019,7 +2019,7 @@ export const mutate: {
    * @see {@link pick} for keeping selected services
    * @see {@link omit} for removing selected services
    *
-   * @category utils
+   * @category mutations
    * @since 4.0.0
    */
   <Services, B>(f: (context: Context<Services>) => Context<B>): <Services>(self: Context<Services>) => Context<B>
@@ -2038,7 +2038,7 @@ export const mutate: {
    * @see {@link pick} for keeping selected services
    * @see {@link omit} for removing selected services
    *
-   * @category utils
+   * @category mutations
    * @since 4.0.0
    */
   <Services, B>(self: Context<Services>, f: (context: Context<Services>) => Context<B>): Context<B>
@@ -2060,7 +2060,7 @@ export const mutate: {
      * @see {@link pick} for keeping selected services
      * @see {@link omit} for removing selected services
      *
-     * @category utils
+     * @category mutations
      * @since 4.0.0
      */
     Services>(new Map(self.mapUnsafe))

package/src/Cron.ts

@@ -690,7 +690,7 @@ export const parseUnsafe = (cron: string, tz?: DateTime.TimeZone | string): Cron
  * @see {@link next} for finding the next matching date/time
  * @see {@link prev} for finding the previous matching date/time
  *
- * @category utils
+ * @category predicates
  * @since 2.0.0
  */
 export const match = (cron: Cron, date: DateTime.DateTime.Input): boolean => {
@@ -766,7 +766,7 @@ const daysInMonth = (date: Date): number =>
  * @see {@link prev} for finding the previous scheduled occurrence
  * @see {@link sequence} for iterating future scheduled occurrences
  *
- * @category utils
+ * @category getters
  * @since 2.0.0
  */
 export const next = (cron: Cron, now?: DateTime.DateTime.Input): Date => {
@@ -792,7 +792,7 @@ export const next = (cron: Cron, now?: DateTime.DateTime.Input): Date => {
  *
  * @see {@link next} for finding the next scheduled occurrence
  *
- * @category utils
+ * @category getters
  * @since 3.20.0
  */
 export const prev = (cron: Cron, now?: DateTime.DateTime.Input): Date => {
@@ -983,7 +983,7 @@ const stepCron = (cron: Cron, now: DateTime.DateTime.Input | undefined, directio
  *
  * @see {@link next} for computing one next occurrence
  *
- * @category utils
+ * @category sequencing
  * @since 2.0.0
  */
 export const sequence = function*(cron: Cron, now?: DateTime.DateTime.Input): IterableIterator<Date> {

package/src/Deferred.ts

@@ -314,7 +314,7 @@ export {
  *
  * @see {@link completeWith} for storing an effect directly without memoizing its result
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const complete: {
@@ -349,7 +349,7 @@ export const complete: {
    *
    * @see {@link completeWith} for storing an effect directly without memoizing its result
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E, R>(effect: Effect<A, E, R>): (self: Deferred<A, E>) => Effect<boolean, never, R>
@@ -384,7 +384,7 @@ export const complete: {
    *
    * @see {@link completeWith} for storing an effect directly without memoizing its result
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E, R>(self: Deferred<A, E>, effect: Effect<A, E, R>): Effect<boolean, never, R>
@@ -430,7 +430,7 @@ export const complete: {
  * @see {@link complete} for running an effect once and sharing its result
  * @see {@link done} for completing from an already computed `Exit`
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const completeWith: {
@@ -470,7 +470,7 @@ export const completeWith: {
    * @see {@link complete} for running an effect once and sharing its result
    * @see {@link done} for completing from an already computed `Exit`
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(effect: Effect<A, E>): (self: Deferred<A, E>) => Effect<boolean>
@@ -510,7 +510,7 @@ export const completeWith: {
    * @see {@link complete} for running an effect once and sharing its result
    * @see {@link done} for completing from an already computed `Exit`
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(self: Deferred<A, E>, effect: Effect<A, E>): Effect<boolean>
@@ -552,7 +552,7 @@ export const completeWith: {
  * @see {@link succeed} for completing with a success value
  * @see {@link failCause} for completing with a failure cause
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const done: {
@@ -588,7 +588,7 @@ export const done: {
    * @see {@link succeed} for completing with a success value
    * @see {@link failCause} for completing with a failure cause
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(exit: Exit.Exit<A, E>): (self: Deferred<A, E>) => Effect<boolean>
@@ -624,7 +624,7 @@ export const done: {
    * @see {@link succeed} for completing with a success value
    * @see {@link failCause} for completing with a failure cause
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(self: Deferred<A, E>, exit: Exit.Exit<A, E>): Effect<boolean>
@@ -655,7 +655,7 @@ export const done: {
  * })
  * ```
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const fail: {
@@ -684,7 +684,7 @@ export const fail: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <E>(error: E): <A>(self: Deferred<A, E>) => Effect<boolean>
@@ -713,7 +713,7 @@ export const fail: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(self: Deferred<A, E>, error: E): Effect<boolean>
@@ -745,7 +745,7 @@ export const fail: {
  * })
  * ```
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const failSync: {
@@ -775,7 +775,7 @@ export const failSync: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <E>(evaluate: LazyArg<E>): <A>(self: Deferred<A, E>) => Effect<boolean>
@@ -805,7 +805,7 @@ export const failSync: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(self: Deferred<A, E>, evaluate: LazyArg<E>): Effect<boolean>
@@ -843,7 +843,7 @@ export const failSync: {
  * })
  * ```
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const failCause: {
@@ -875,7 +875,7 @@ export const failCause: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <E>(cause: Cause.Cause<E>): <A>(self: Deferred<A, E>) => Effect<boolean>
@@ -907,7 +907,7 @@ export const failCause: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(self: Deferred<A, E>, cause: Cause.Cause<E>): Effect<boolean>
@@ -945,7 +945,7 @@ export const failCause: {
  * })
  * ```
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const failCauseSync: {
@@ -978,7 +978,7 @@ export const failCauseSync: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <E>(evaluate: LazyArg<Cause.Cause<E>>): <A>(self: Deferred<A, E>) => Effect<boolean>
@@ -1011,7 +1011,7 @@ export const failCauseSync: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(self: Deferred<A, E>, evaluate: LazyArg<Cause.Cause<E>>): Effect<boolean>
@@ -1049,7 +1049,7 @@ export const failCauseSync: {
  * })
  * ```
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const die: {
@@ -1081,7 +1081,7 @@ export const die: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   (defect: unknown): <A, E>(self: Deferred<A, E>) => Effect<boolean>
@@ -1113,7 +1113,7 @@ export const die: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(self: Deferred<A, E>, defect: unknown): Effect<boolean>
@@ -1148,7 +1148,7 @@ export const die: {
  * })
  * ```
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const dieSync: {
@@ -1181,7 +1181,7 @@ export const dieSync: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   (evaluate: LazyArg<unknown>): <A, E>(self: Deferred<A, E>) => Effect<boolean>
@@ -1214,7 +1214,7 @@ export const dieSync: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(self: Deferred<A, E>, evaluate: LazyArg<unknown>): Effect<boolean>
@@ -1250,7 +1250,7 @@ export const dieSync: {
  * })
  * ```
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const interrupt = <A, E>(self: Deferred<A, E>): Effect<boolean> =>
@@ -1282,7 +1282,7 @@ export const interrupt = <A, E>(self: Deferred<A, E>): Effect<boolean> =>
  * })
  * ```
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const interruptWith: {
@@ -1312,7 +1312,7 @@ export const interruptWith: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   (fiberId: number): <A, E>(self: Deferred<A, E>) => Effect<boolean>
@@ -1342,7 +1342,7 @@ export const interruptWith: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(self: Deferred<A, E>, fiberId: number): Effect<boolean>
@@ -1457,7 +1457,7 @@ export function poll<A, E>(self: Deferred<A, E>): Effect<Option.Option<Effect<A,
  * })
  * ```
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const succeed: {
@@ -1488,7 +1488,7 @@ export const succeed: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A>(value: A): <E>(self: Deferred<A, E>) => Effect<boolean>
@@ -1519,7 +1519,7 @@ export const succeed: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(self: Deferred<A, E>, value: A): Effect<boolean>
@@ -1553,7 +1553,7 @@ export const succeed: {
  * })
  * ```
  *
- * @category utils
+ * @category completion
  * @since 2.0.0
  */
 export const sync: {
@@ -1585,7 +1585,7 @@ export const sync: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A>(evaluate: LazyArg<A>): <E>(self: Deferred<A, E>) => Effect<boolean>
@@ -1617,7 +1617,7 @@ export const sync: {
    * })
    * ```
    *
-   * @category utils
+   * @category completion
    * @since 2.0.0
    */
   <A, E>(self: Deferred<A, E>, evaluate: LazyArg<A>): Effect<boolean>

package/src/Duration.ts

@@ -1459,7 +1459,7 @@ export const min: {
  * console.log(Duration.toSeconds(longer)) // 5
  * ```
  *
- * @category order
+ * @category ordering
  * @since 2.0.0
  */
 export const max: {
@@ -1475,7 +1475,7 @@ export const max: {
    * console.log(Duration.toSeconds(longer)) // 5
    * ```
    *
-   * @category order
+   * @category ordering
    * @since 2.0.0
    */
   (that: Duration): (self: Duration) => Duration
@@ -1491,7 +1491,7 @@ export const max: {
    * console.log(Duration.toSeconds(longer)) // 5
    * ```
    *
-   * @category order
+   * @category ordering
    * @since 2.0.0
    */
   (self: Duration, that: Duration): Duration
@@ -1512,7 +1512,7 @@ export const max: {
  * console.log(Duration.toSeconds(clamped)) // 5
  * ```
  *
- * @category order
+ * @category ordering
  * @since 2.0.0
  */
 export const clamp: {
@@ -1531,7 +1531,7 @@ export const clamp: {
    * console.log(Duration.toSeconds(clamped)) // 5
    * ```
    *
-   * @category order
+   * @category ordering
    * @since 2.0.0
    */
   (options: { minimum: Duration; maximum: Duration }): (self: Duration) => Duration
@@ -1550,7 +1550,7 @@ export const clamp: {
    * console.log(Duration.toSeconds(clamped)) // 5
    * ```
    *
-   * @category order
+   * @category ordering
    * @since 2.0.0
    */
   (self: Duration, options: { minimum: Duration; maximum: Duration }): Duration