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

package/dist/Channel.js

@@ -1827,7 +1827,7 @@ export const flatten = channels => flatMap(channels, identity_);
  * // Outputs: 1, 2, 3, 4, 5, 6, 7, 8, 9
  * ```
  *
- * @category utils
+ * @category transforming
  * @since 4.0.0
  */
 export const flattenArray = self => transformPull(self, pull => {
@@ -1867,7 +1867,7 @@ export const flattenArray = self => transformPull(self, pull => {
  * Output `Take` values are emitted as non-empty arrays. Failed `Take` values
  * fail the returned channel. Done `Take` values complete the returned channel.
  *
- * @category utils
+ * @category transforming
  * @since 4.0.0
  */
 export const flattenTake = self => mapEffectSequential(self, Take.toPull);
@@ -1899,7 +1899,7 @@ export const drain = self => transformPull(self, pull => Effect.succeed(Effect.f
 /**
  * Repeats this channel according to the provided schedule.
  *
- * @category utils
+ * @category repetition
  * @since 4.0.0
  */
 export const repeat = /*#__PURE__*/dual(2, (self, schedule) => Schedule.toStepWithMetadata(typeof schedule === "function" ? schedule(identity_) : schedule).pipe(Effect.map(step => {
@@ -1913,7 +1913,7 @@ export const repeat = /*#__PURE__*/dual(2, (self, schedule) => Schedule.toStepWi
 /**
  * Repeats this channel forever.
  *
- * @category utils
+ * @category repetition
  * @since 4.0.0
  */
 export const forever = self => concatWith(self, () => forever(self));
@@ -1928,7 +1928,7 @@ export const forever = self => concatWith(self, () => forever(self));
  * fails. If the schedule finishes, the returned channel completes with the
  * schedule output.
  *
- * @category utils
+ * @category sequencing
  * @since 4.0.0
  */
 export const schedule = /*#__PURE__*/dual(2, (self, schedule) => transformPull(self, (pull, _scope) => Effect.map(Schedule.toStepWithSleep(schedule), step => {
@@ -2672,7 +2672,7 @@ export const ignoreCause = /*#__PURE__*/dual(args => isChannel(args[0]), (self,
  * Returns a new channel that retries this channel according to the specified
  * schedule whenever it fails.
  *
- * @category utils
+ * @category error handling
  * @since 4.0.0
  */
 export const retry = /*#__PURE__*/dual(2, (self, schedule) => suspend(() => {
@@ -2760,7 +2760,7 @@ export const switchMap = /*#__PURE__*/dual(args => isChannel(args[0]), (self, f,
  * // Outputs: 1, 2, 3, 4, 5, 6 (order may vary due to concurrency)
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const mergeAll = /*#__PURE__*/dual(2, (channels, {
@@ -2831,7 +2831,7 @@ export const mergeAll = /*#__PURE__*/dual(2, (channels, {
  * // Order may vary: 1, "a", 2, "b", 3, "c"
  * ```
  *
- * @category utils
+ * @category combining
  * @since 4.0.0
  */
 export const merge = /*#__PURE__*/dual(args => isChannel(args[0]) && isChannel(args[1]), (left, right, options) => fromTransformBracket(Effect.fnUntraced(function* (upstream, _scope, forkedScope) {
@@ -2874,7 +2874,7 @@ export const merge = /*#__PURE__*/dual(args => isChannel(args[0]) && isChannel(a
  * The effect's successful value is ignored. If the effect fails while the
  * channel is running, the returned channel fails with that error.
  *
- * @category utils
+ * @category combining
  * @since 4.0.0
  */
 export const mergeEffect = /*#__PURE__*/dual(2, (self, effect) => merge(self, fromEffectDrain(effect), {
@@ -3052,7 +3052,7 @@ export const encodeText = () => fromTransform((upstream, _scope) => Effect.sync(
  * // Outputs: 2, 4, 6
  * ```
  *
- * @category utils
+ * @category sequencing
  * @since 2.0.0
  */
 export const pipeTo = /*#__PURE__*/dual(2, (self, that) => fromTransform((upstream, scope) => Effect.flatMap(toTransform(self)(upstream, scope), upstream => toTransform(that)(upstream, scope))));
@@ -3080,7 +3080,7 @@ export const pipeTo = /*#__PURE__*/dual(2, (self, that) => fromTransform((upstre
  * // Source errors are preserved and not sent to transform channel
  * ```
  *
- * @category utils
+ * @category sequencing
  * @since 2.0.0
  */
 export const pipeToOrFail = /*#__PURE__*/dual(2, (self, that) => fromTransform((upstream, scope) => Effect.flatMap(toTransform(self)(upstream, scope), upstream => {
@@ -3125,7 +3125,7 @@ export const unwrap = channel => fromTransform((upstream, scope) => {
  * Runs a channel with a scope provided for the duration of the channel
  * execution, removing the channel's `Scope` requirement.
  *
- * @category utils
+ * @category resource management
  * @since 2.0.0
  */
 export const scoped = self => fromTransformBracket((upstream, scope, forkedScope) => Effect.map(Scope.provide(toTransform(self)(upstream, scope), forkedScope), Scope.provide(forkedScope)));
@@ -3160,7 +3160,7 @@ export const scoped = self => fromTransformBracket((upstream, scope, forkedScope
  * )
  * ```
  *
- * @category utils
+ * @category sequencing
  * @since 2.0.0
  */
 export const embedInput = /*#__PURE__*/dual(2, (self, input) => fromTransformBracket((upstream, scope, forkedScope) => Effect.andThen(Effect.forkIn(input(upstream), forkedScope), toTransform(self)(Cause.done(), scope))));
@@ -3244,7 +3244,7 @@ export const bufferArray = /*#__PURE__*/dual(2, (self, options) => fromTransform
  * channel's done value. If the channel completes first, the original channel's
  * done value is preserved.
  *
- * @category utils
+ * @category interruption
  * @since 2.0.0
  */
 export const interruptWhen = /*#__PURE__*/dual(2, (self, effect) => merge(self, fromPull(Effect.succeed(Effect.flatMap(effect, Cause.done))), {
@@ -3260,7 +3260,7 @@ export const interruptWhen = /*#__PURE__*/dual(2, (self, effect) => merge(self,
  * fails with that error. If the channel completes first, the channel's done
  * value is preserved.
  *
- * @category utils
+ * @category interruption
  * @since 4.0.0
  */
 export const haltWhen = /*#__PURE__*/dual(2, (self, effect) => fromTransformBracket(Effect.fnUntraced(function* (upstream, scope, forkedScope) {
@@ -3280,7 +3280,7 @@ export const haltWhen = /*#__PURE__*/dual(2, (self, effect) => fromTransformBrac
  * The finalizer receives the failure `Cause`. The original channel failure is
  * preserved. The finalizer itself must not fail.
  *
- * @category utils
+ * @category error handling
  * @since 4.0.0
  */
 export const onError = /*#__PURE__*/dual(2, (self, finalizer) => onExit(self, exit => Exit.isFailure(exit) ? finalizer(exit.cause) : Effect.void));
@@ -3310,7 +3310,7 @@ export const onError = /*#__PURE__*/dual(2, (self, finalizer) => onExit(self, ex
  * })
  * ```
  *
- * @category utils
+ * @category resource management
  * @since 4.0.0
  */
 export const onExit = /*#__PURE__*/dual(2, (self, finalizer) => fromTransformBracket((upstream, scope, forkedScope) => Scope.addFinalizerExit(forkedScope, finalizer).pipe(Effect.andThen(toTransform(self)(upstream, scope)))));
@@ -3322,7 +3322,7 @@ export const onExit = /*#__PURE__*/dual(2, (self, finalizer) => fromTransformBra
  * The effect's successful value is ignored. If the effect fails, the returned
  * channel fails before running the source channel.
  *
- * @category utils
+ * @category hooks
  * @since 4.0.0
  */
 export const onStart = /*#__PURE__*/dual(2, (self, onStart) => unwrap(Effect.as(onStart, self)));
@@ -3335,7 +3335,7 @@ export const onStart = /*#__PURE__*/dual(2, (self, onStart) => unwrap(Effect.as(
  * emitted unchanged. The effect is not run if the channel completes without
  * emitting an element.
  *
- * @category utils
+ * @category hooks
  * @since 4.0.0
  */
 export const onFirst = /*#__PURE__*/dual(2, (self, onFirst) => transformPull(self, pull => Effect.sync(() => {
@@ -3355,7 +3355,7 @@ export const onFirst = /*#__PURE__*/dual(2, (self, onFirst) => transformPull(sel
  * not run when the channel fails. If the effect fails, the returned channel
  * fails with that error.
  *
- * @category utils
+ * @category hooks
  * @since 4.0.0
  */
 export const onEnd = /*#__PURE__*/dual(2, (self, onEnd) => transformPull(self, pull => Effect.succeed(Pull.catchDone(pull, leftover => Effect.flatMap(onEnd, () => Cause.done(leftover))))));
@@ -3382,7 +3382,7 @@ export const onEnd = /*#__PURE__*/dual(2, (self, onEnd) => transformPull(self, p
  * )
  * ```
  *
- * @category utils
+ * @category resource management
  * @since 2.0.0
  */
 export const ensuring = /*#__PURE__*/dual(2, (self, finalizer) => onExit(self, _ => finalizer));
@@ -3502,7 +3502,7 @@ const withSpanImpl = (self, name, options) => acquireUseRelease(Effect.makeSpan(
 /**
  * The starting channel for Do notation, emitting an empty object.
  *
- * @category Do notation
+ * @category do notation
  * @since 4.0.0
  */
 export const Do = /*#__PURE__*/succeed({});
@@ -3514,7 +3514,7 @@ export {
 /**
  * Adds a computed field to each object emitted by a channel.
  *
- * @category Do notation
+ * @category do notation
  * @since 4.0.0
  */
 let_ as let };
@@ -3528,7 +3528,7 @@ let_ as let };
  * channel's output becomes the value of the new field. `options.concurrency`
  * and `options.bufferSize` control how derived channels are flattened.
  *
- * @category Do notation
+ * @category do notation
  * @since 4.0.0
  */
 export const bind = /*#__PURE__*/dual(args => isChannel(args[0]), (self, name, f, options) => flatMap(self, elem => map(f(elem), b => ({
@@ -3547,7 +3547,7 @@ export const bind = /*#__PURE__*/dual(args => isChannel(args[0]), (self, name, f
  * @see {@link bind} for adding a field produced by another channel
  * @see {@link let_ let} for adding a computed field
  *
- * @category Do notation
+ * @category do notation
  * @since 4.0.0
  */
 export const bindTo = /*#__PURE__*/dual(2, (self, name) => map(self, elem => ({

package/dist/Chunk.d.ts

@@ -190,7 +190,7 @@ interface ISlice<A> {
  * console.log(eq(chunk1, chunk3)) // false
  * ```
  *
- * @category equivalence
+ * @category instances
  * @since 4.0.0
  */
 export declare const makeEquivalence: <A>(isEquivalent: Equivalence.Equivalence<A>) => Equivalence.Equivalence<Chunk<A>>;
@@ -602,7 +602,7 @@ export declare 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 declare const append: {
@@ -632,7 +632,7 @@ export declare 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>;
@@ -662,7 +662,7 @@ export declare 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>;
@@ -685,7 +685,7 @@ export declare const append: {
  * console.log(Chunk.toArray(singleElement)) // ["first"]
  * ```
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export declare const prepend: {
@@ -707,7 +707,7 @@ export declare 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>;
@@ -729,7 +729,7 @@ export declare 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>;
@@ -960,7 +960,7 @@ export declare const dropWhile: {
  * // [ "a", "b", 1, 2 ]
  * ```
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export declare const prependAll: {
@@ -982,7 +982,7 @@ export declare 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>>;
@@ -1004,7 +1004,7 @@ export declare 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>;
@@ -1026,7 +1026,7 @@ export declare 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>;
@@ -1048,7 +1048,7 @@ export declare 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>;
@@ -1079,7 +1079,7 @@ export declare 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 declare const appendAll: {
@@ -1109,7 +1109,7 @@ export declare 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>>;
@@ -1139,7 +1139,7 @@ export declare 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>;
@@ -1169,7 +1169,7 @@ export declare 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>;
@@ -1199,7 +1199,7 @@ export declare 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>;

package/dist/Chunk.js

@@ -108,7 +108,7 @@ const emptyArray = [];
  * console.log(eq(chunk1, chunk3)) // false
  * ```
  *
- * @category equivalence
+ * @category instances
  * @since 4.0.0
  */
 export const makeEquivalence = isEquivalent => Equivalence.make((self, that) => self.length === that.length && toReadonlyArray(self).every((value, i) => isEquivalent(value, getUnsafe(that, i))));
@@ -597,7 +597,7 @@ export const getUnsafe = /*#__PURE__*/dual(2, (self, index) => {
  * @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 = /*#__PURE__*/dual(2, (self, a) => appendAll(self, of(a)));
@@ -619,7 +619,7 @@ export const append = /*#__PURE__*/dual(2, (self, a) => appendAll(self, of(a)));
  * console.log(Chunk.toArray(singleElement)) // ["first"]
  * ```
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export const prepend = /*#__PURE__*/dual(2, (self, elem) => appendAll(of(elem), self));
@@ -793,7 +793,7 @@ export const dropWhile = /*#__PURE__*/dual(2, (self, predicate) => {
  * // [ "a", "b", 1, 2 ]
  * ```
  *
- * @category concatenating
+ * @category combining
  * @since 2.0.0
  */
 export const prependAll = /*#__PURE__*/dual(2, (self, that) => appendAll(that, self));
@@ -823,7 +823,7 @@ export const prependAll = /*#__PURE__*/dual(2, (self, that) => appendAll(that, s
  * @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 = /*#__PURE__*/dual(2, (self, that) => {

package/dist/Context.d.ts

@@ -1722,7 +1722,7 @@ export declare const omit: <S extends ReadonlyArray<Key<any, any>>>(...keys: S)
  * @see {@link pick} for keeping selected services
  * @see {@link omit} for removing selected services
  *
- * @category utils
+ * @category mutations
  * @since 4.0.0
  */
 export declare const mutate: {
@@ -1741,7 +1741,7 @@ export declare 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>;
@@ -1760,7 +1760,7 @@ export declare 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>;

package/dist/Context.js

@@ -831,7 +831,7 @@ export const omit = (...keys) => self => withMapUnsafe(self, map => {
  * @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 = /*#__PURE__*/dual(2, (self, f) => {

package/dist/Cron.d.ts

@@ -423,7 +423,7 @@ export declare const parseUnsafe: (cron: string, tz?: DateTime.TimeZone | string
  * @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 declare const match: (cron: Cron, date: DateTime.DateTime.Input) => boolean;
@@ -461,7 +461,7 @@ export declare const match: (cron: Cron, date: DateTime.DateTime.Input) => boole
  * @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 declare const next: (cron: Cron, now?: DateTime.DateTime.Input) => Date;
@@ -484,7 +484,7 @@ export declare 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 declare const prev: (cron: Cron, now?: DateTime.DateTime.Input) => Date;
@@ -518,7 +518,7 @@ export declare const prev: (cron: Cron, now?: DateTime.DateTime.Input) => Date;
  *
  * @see {@link next} for computing one next occurrence
  *
- * @category utils
+ * @category sequencing
  * @since 2.0.0
  */
 export declare const sequence: (cron: Cron, now?: DateTime.DateTime.Input) => IterableIterator<Date>;

package/dist/Cron.js

@@ -522,7 +522,7 @@ export const parseUnsafe = (cron, tz) => Result.getOrThrow(parse(cron, tz));
  * @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, date) => {
@@ -587,7 +587,7 @@ const daysInMonth = date => new Date(Date.UTC(date.getUTCFullYear(), date.getUTC
  * @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, now) => {
@@ -612,7 +612,7 @@ export const next = (cron, now) => {
  *
  * @see {@link next} for finding the next scheduled occurrence
  *
- * @category utils
+ * @category getters
  * @since 3.20.0
  */
 export const prev = (cron, now) => {
@@ -781,7 +781,7 @@ const stepCron = (cron, now, direction) => {
  *
  * @see {@link next} for computing one next occurrence
  *
- * @category utils
+ * @category sequencing
  * @since 2.0.0
  */
 export const sequence = function* (cron, now) {