effect 4.0.0-beta.73 → 4.0.0-beta.74

package/dist/Schedule.d.ts

@@ -474,7 +474,7 @@ export declare const toStepWithSleep: <Output, Input, Error, Env>(schedule: Sche
  * })
  * ```
  *
- * @category utils
+ * @category delays & timeouts
  * @since 2.0.0
  */
 export declare const addDelay: {
@@ -574,7 +574,7 @@ export declare const addDelay: {
      * })
      * ```
      *
-     * @category utils
+     * @category delays & timeouts
      * @since 2.0.0
      */
     <Output, Error2 = never, Env2 = never>(f: (output: Output) => Effect<Duration.Input, Error2, Env2>): <Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Output, Input, Error | Error2, Env | Env2>;
@@ -674,7 +674,7 @@ export declare const addDelay: {
      * })
      * ```
      *
-     * @category utils
+     * @category delays & timeouts
      * @since 2.0.0
      */
     <Output, Input, Error, Env, Error2 = never, Env2 = never>(self: Schedule<Output, Input, Error, Env>, f: (output: Output) => Effect<Duration.Input, Error2, Env2>): Schedule<Output, Input, Error | Error2, Env | Env2>;
@@ -1008,7 +1008,7 @@ export declare const andThenResult: {
  *
  * @see {@link either} for continuing while either schedule still recurs
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export declare const both: {
@@ -1087,7 +1087,7 @@ export declare const both: {
      *
      * @see {@link either} for continuing while either schedule still recurs
      *
-     * @category utils
+     * @category combining
      * @since 2.0.0
      */
     <Output2, Input2, Error2, Env2, Output>(other: Schedule<Output2, Input2, Error2, Env2>): <Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<[Output, Output2], Input & Input2, Error | Error2, Env | Env2>;
@@ -1166,7 +1166,7 @@ export declare const both: {
      *
      * @see {@link either} for continuing while either schedule still recurs
      *
-     * @category utils
+     * @category combining
      * @since 2.0.0
      */
     <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(self: Schedule<Output, Input, Error, Env>, other: Schedule<Output2, Input2, Error2, Env2>): Schedule<[Output, Output2], Input & Input2, Error | Error2, Env | Env2>;
@@ -1200,7 +1200,7 @@ export declare const both: {
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export declare const bothLeft: {
@@ -1233,7 +1233,7 @@ export declare const bothLeft: {
      * })
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 2.0.0
      */
     <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Output, Input & Input2, Error | Error2, Env | Env2>;
@@ -1266,7 +1266,7 @@ export declare const bothLeft: {
      * })
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 2.0.0
      */
     <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(self: Schedule<Output, Input, Error, Env>, other: Schedule<Output2, Input2, Error2, Env2>): Schedule<Output, Input & Input2, Error | Error2, Env | Env2>;
@@ -1302,7 +1302,7 @@ export declare const bothLeft: {
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export declare const bothRight: {
@@ -1337,7 +1337,7 @@ export declare const bothRight: {
      * })
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 2.0.0
      */
     <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Output, Input & Input2, Error | Error2, Env | Env2>;
@@ -1372,7 +1372,7 @@ export declare const bothRight: {
      * })
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 2.0.0
      */
     <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(self: Schedule<Output, Input, Error, Env>, other: Schedule<Output2, Input2, Error2, Env2>): Schedule<Output, Input & Input2, Error | Error2, Env | Env2>;
@@ -1413,7 +1413,7 @@ export declare const bothRight: {
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export declare const bothWith: {
@@ -1453,7 +1453,7 @@ export declare const bothWith: {
      * })
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 2.0.0
      */
     <Output2, Input2, Error2, Env2, Output, Output3>(other: Schedule<Output2, Input2, Error2, Env2>, combine: (selfOutput: Output, otherOutput: Output2) => Output3): <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Output3, Input & Input2, Error | Error2, Env | Env2>;
@@ -1493,7 +1493,7 @@ export declare const bothWith: {
      * })
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 2.0.0
      */
     <Output, Input, Error, Env, Output2, Input2, Error2, Env2, Output3>(self: Schedule<Output, Input, Error, Env>, other: Schedule<Output2, Input2, Error2, Env2>, combine: (selfOutput: Output, otherOutput: Output2) => Output3): Schedule<Output3, Input & Input2, Error | Error2, Env | Env2>;
@@ -1530,7 +1530,7 @@ export declare const bothWith: {
  * })
  * ```
  *
- * @category utils
+ * @category collecting
  * @since 4.0.0
  */
 export declare const collectInputs: <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Array<Input>, Input, Error, Env>;
@@ -1564,7 +1564,7 @@ export declare const collectInputs: <Output, Input, Error, Env>(self: Schedule<O
  * })
  * ```
  *
- * @category utils
+ * @category collecting
  * @since 4.0.0
  */
 export declare const collectOutputs: <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Array<Output>, Input, Error, Env>;
@@ -1648,7 +1648,7 @@ export declare const collectOutputs: <Output, Input, Error, Env>(self: Schedule<
  * })
  * ```
  *
- * @category utils
+ * @category collecting
  * @since 2.0.0
  */
 export declare const collectWhile: {
@@ -1732,7 +1732,7 @@ export declare const collectWhile: {
      * })
      * ```
      *
-     * @category utils
+     * @category collecting
      * @since 2.0.0
      */
     <Input, Output, Error2 = never, Env2 = never>(predicate: (metadata: Metadata<Output, Input>) => boolean | Effect<boolean, Error2, Env2>): <Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Array<Output>, Input, Error | Error2, Env | Env2>;
@@ -1816,7 +1816,7 @@ export declare const collectWhile: {
      * })
      * ```
      *
-     * @category utils
+     * @category collecting
      * @since 2.0.0
      */
     <Output, Input, Error, Env, Error2 = never, Env2 = never>(self: Schedule<Output, Input, Error, Env>, predicate: (metadata: Metadata<Output, Input>) => boolean | Effect<boolean, Error2, Env2>): Schedule<Array<Output>, Input, Error | Error2, Env | Env2>;
@@ -2502,7 +2502,7 @@ export declare const during: (duration: Duration.Input) => Schedule<Duration.Dur
  *
  * @see {@link both} for continuing only while both schedules still recur
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export declare const either: {
@@ -2582,7 +2582,7 @@ export declare const either: {
      *
      * @see {@link both} for continuing only while both schedules still recur
      *
-     * @category utils
+     * @category combining
      * @since 2.0.0
      */
     <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<[Output, Output2], Input & Input2, Error | Error2, Env | Env2>;
@@ -2662,7 +2662,7 @@ export declare const either: {
      *
      * @see {@link both} for continuing only while both schedules still recur
      *
-     * @category utils
+     * @category combining
      * @since 2.0.0
      */
     <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(self: Schedule<Output, Input, Error, Env>, other: Schedule<Output2, Input2, Error2, Env2>): Schedule<[Output, Output2], Input & Input2, Error | Error2, Env | Env2>;
@@ -2699,7 +2699,7 @@ export declare const either: {
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 4.0.0
  */
 export declare const eitherLeft: {
@@ -2735,7 +2735,7 @@ export declare const eitherLeft: {
      * })
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 4.0.0
      */
     <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Output, Input & Input2, Error | Error2, Env | Env2>;
@@ -2771,7 +2771,7 @@ export declare const eitherLeft: {
      * })
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 4.0.0
      */
     <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(self: Schedule<Output, Input, Error, Env>, other: Schedule<Output2, Input2, Error2, Env2>): Schedule<Output, Input & Input2, Error | Error2, Env | Env2>;
@@ -2808,7 +2808,7 @@ export declare const eitherLeft: {
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 4.0.0
  */
 export declare const eitherRight: {
@@ -2844,7 +2844,7 @@ export declare const eitherRight: {
      * })
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 4.0.0
      */
     <Output2, Input2, Error2, Env2>(other: Schedule<Output2, Input2, Error2, Env2>): <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Output2, Input & Input2, Error | Error2, Env | Env2>;
@@ -2880,7 +2880,7 @@ export declare const eitherRight: {
      * })
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 4.0.0
      */
     <Output, Input, Error, Env, Output2, Input2, Error2, Env2>(self: Schedule<Output, Input, Error, Env>, other: Schedule<Output2, Input2, Error2, Env2>): Schedule<Output2, Input & Input2, Error | Error2, Env | Env2>;
@@ -2922,7 +2922,7 @@ export declare const eitherRight: {
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export declare const eitherWith: {
@@ -2963,7 +2963,7 @@ export declare const eitherWith: {
      * })
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 2.0.0
      */
     <Output2, Input2, Error2, Env2, Output, Output3>(other: Schedule<Output2, Input2, Error2, Env2>, combine: (selfOutput: Output, otherOutput: Output2) => Output3): <Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Output3, Input & Input2, Error | Error2, Env | Env2>;
@@ -3004,7 +3004,7 @@ export declare const eitherWith: {
      * })
      * ```
      *
-     * @category utils
+     * @category combining
      * @since 2.0.0
      */
     <Output, Input, Error, Env, Output2, Input2, Error2, Env2, Output3>(self: Schedule<Output, Input, Error, Env>, other: Schedule<Output2, Input2, Error2, Env2>, combine: (selfOutput: Output, otherOutput: Output2) => Output3): Schedule<Output3, Input & Input2, Error | Error2, Env | Env2>;
@@ -3452,7 +3452,7 @@ export declare const map: {
  * })
  * ```
  *
- * @category utils
+ * @category delays & timeouts
  * @since 2.0.0
  */
 export declare const modifyDelay: {
@@ -3486,7 +3486,7 @@ export declare const modifyDelay: {
      * })
      * ```
      *
-     * @category utils
+     * @category delays & timeouts
      * @since 2.0.0
      */
     <Output, Error2 = never, Env2 = never>(f: (output: Output, delay: Duration.Duration) => Effect<Duration.Input, Error2, Env2>): <Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Output, Input, Error | Error2, Env | Env2>;
@@ -3520,7 +3520,7 @@ export declare const modifyDelay: {
      * })
      * ```
      *
-     * @category utils
+     * @category delays & timeouts
      * @since 2.0.0
      */
     <Output, Input, Error, Env, Error2 = never, Env2 = never>(self: Schedule<Output, Input, Error, Env>, f: (output: Output, delay: Duration.Input) => Effect<Duration.Input, Error2, Env2>): Schedule<Output, Input, Error | Error2, Env | Env2>;
@@ -3539,7 +3539,7 @@ export declare const modifyDelay: {
  *
  * @see {@link modifyDelay} for replacing recurrence delays with a custom effectful transformation
  *
- * @category utils
+ * @category delays & timeouts
  * @since 2.0.0
  */
 export declare const jittered: <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Output, Input, Error, Env>;
@@ -3569,7 +3569,7 @@ export declare const jittered: <Output, Input, Error, Env>(self: Schedule<Output
  * })
  * ```
  *
- * @category utils
+ * @category mapping
  * @since 2.0.0
  */
 export declare const passthrough: <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Input, Input, Error, Env>;
@@ -3754,7 +3754,7 @@ export declare const recurs: (times: number) => Schedule<number>;
  * })
  * ```
  *
- * @category utils
+ * @category folding
  * @since 2.0.0
  */
 export declare const reduce: {
@@ -3867,7 +3867,7 @@ export declare const reduce: {
      * })
      * ```
      *
-     * @category utils
+     * @category folding
      * @since 2.0.0
      */
     <State, Output, Error2 = never, Env2 = never>(initial: LazyArg<State>, combine: (state: State, output: Output) => State | Effect<State, Error2, Env2>): <Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<State, Input, Error | Error2, Env | Env2>;
@@ -3980,7 +3980,7 @@ export declare const reduce: {
      * })
      * ```
      *
-     * @category utils
+     * @category folding
      * @since 2.0.0
      */
     <Output, Input, Error, Env, State, Error2 = never, Env2 = never>(self: Schedule<Output, Input, Error, Env>, initial: LazyArg<State>, combine: (state: State, output: Output) => State | Effect<State, Error2, Env2>): Schedule<State, Input, Error | Error2, Env | Env2>;
@@ -4886,7 +4886,7 @@ export declare const tapOutput: {
  *
  * @see {@link recurs} for creating a count-limited schedule
  *
- * @category utils
+ * @category taking
  * @since 4.0.0
  */
 export declare const take: {
@@ -4982,7 +4982,7 @@ export declare const take: {
      *
      * @see {@link recurs} for creating a count-limited schedule
      *
-     * @category utils
+     * @category taking
      * @since 4.0.0
      */
     (n: number): <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>) => Schedule<Output, Input, Error, Env>;
@@ -5078,7 +5078,7 @@ export declare const take: {
      *
      * @see {@link recurs} for creating a count-limited schedule
      *
-     * @category utils
+     * @category taking
      * @since 4.0.0
      */
     <Output, Input, Error, Env>(self: Schedule<Output, Input, Error, Env>, n: number): Schedule<Output, Input, Error, Env>;
@@ -5202,7 +5202,7 @@ export {
  * @see {@link collectWhile} for collecting outputs while using the same predicate
  * @see {@link take} for stopping after a fixed number of schedule outputs
  *
- * @category utils
+ * @category filtering
  * @since 4.0.0
  */
 while_ as while };

package/dist/Schedule.js

@@ -395,7 +395,7 @@ export const toStepWithSleep = schedule => effect.map(toStepWithMetadata(schedul
  * })
  * ```
  *
- * @category utils
+ * @category delays & timeouts
  * @since 2.0.0
  */
 export const addDelay = /*#__PURE__*/dual(2, (self, f) => modifyDelay(self, (output, delay) => effect.map(f(output), d => Duration.sum(Duration.fromInputUnsafe(d), Duration.fromInputUnsafe(delay)))));
@@ -578,7 +578,7 @@ export const andThenResult = /*#__PURE__*/dual(2, (self, other) => fromStep(effe
  *
  * @see {@link either} for continuing while either schedule still recurs
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const both = /*#__PURE__*/dual(2, (self, other) => bothWith(self, other, (left, right) => [left, right]));
@@ -611,7 +611,7 @@ export const both = /*#__PURE__*/dual(2, (self, other) => bothWith(self, other,
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const bothLeft = /*#__PURE__*/dual(2, (self, other) => bothWith(self, other, output => output));
@@ -646,7 +646,7 @@ export const bothLeft = /*#__PURE__*/dual(2, (self, other) => bothWith(self, oth
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const bothRight = /*#__PURE__*/dual(2, (self, other) => bothWith(self, other, (_, output) => output));
@@ -686,7 +686,7 @@ export const bothRight = /*#__PURE__*/dual(2, (self, other) => bothWith(self, ot
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const bothWith = /*#__PURE__*/dual(3, (self, other, combine) => fromStep(effect.map(effect.zip(toStep(self), toStep(other)), ([stepLeft, stepRight]) => (now, input) => Pull.matchEffect(stepLeft(now, input), {
@@ -726,7 +726,7 @@ export const bothWith = /*#__PURE__*/dual(3, (self, other, combine) => fromStep(
  * })
  * ```
  *
- * @category utils
+ * @category collecting
  * @since 4.0.0
  */
 export const collectInputs = self => collectWhile(passthrough(self), () => effect.succeed(true));
@@ -760,7 +760,7 @@ export const collectInputs = self => collectWhile(passthrough(self), () => effec
  * })
  * ```
  *
- * @category utils
+ * @category collecting
  * @since 4.0.0
  */
 export const collectOutputs = self => collectWhile(self, () => effect.succeed(true));
@@ -844,7 +844,7 @@ export const collectOutputs = self => collectWhile(self, () => effect.succeed(tr
  * })
  * ```
  *
- * @category utils
+ * @category collecting
  * @since 2.0.0
  */
 export const collectWhile = /*#__PURE__*/dual(2, (self, predicate) => reduce(while_(self, predicate), () => [], (outputs, output) => {
@@ -1279,7 +1279,7 @@ export const during = duration => while_(elapsed, ({
  *
  * @see {@link both} for continuing only while both schedules still recur
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const either = /*#__PURE__*/dual(2, (self, other) => eitherWith(self, other, (left, right) => [left, right]));
@@ -1315,7 +1315,7 @@ export const either = /*#__PURE__*/dual(2, (self, other) => eitherWith(self, oth
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 4.0.0
  */
 export const eitherLeft = /*#__PURE__*/dual(2, (self, other) => eitherWith(self, other, output => output));
@@ -1351,7 +1351,7 @@ export const eitherLeft = /*#__PURE__*/dual(2, (self, other) => eitherWith(self,
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 4.0.0
  */
 export const eitherRight = /*#__PURE__*/dual(2, (self, other) => eitherWith(self, other, (_, output) => output));
@@ -1392,7 +1392,7 @@ export const eitherRight = /*#__PURE__*/dual(2, (self, other) => eitherWith(self
  * })
  * ```
  *
- * @category utils
+ * @category combining
  * @since 2.0.0
  */
 export const eitherWith = /*#__PURE__*/dual(3, (self, other, combine) => fromStep(effect.map(effect.zip(toStep(self), toStep(other)), ([stepLeft, stepRight]) => (now, input) => Pull.matchEffect(stepLeft(now, input), {
@@ -1771,7 +1771,7 @@ export const map = /*#__PURE__*/dual(2, (self, f) => {
  * })
  * ```
  *
- * @category utils
+ * @category delays & timeouts
  * @since 2.0.0
  */
 export const modifyDelay = /*#__PURE__*/dual(2, (self, f) => fromStep(effect.map(toStep(self), step => (now, input) => effect.flatMap(step(now, input), ([output, delay]) => effect.map(f(output, delay), delay => [output, Duration.fromInputUnsafe(delay)])))));
@@ -1789,7 +1789,7 @@ export const modifyDelay = /*#__PURE__*/dual(2, (self, f) => fromStep(effect.map
  *
  * @see {@link modifyDelay} for replacing recurrence delays with a custom effectful transformation
  *
- * @category utils
+ * @category delays & timeouts
  * @since 2.0.0
  */
 export const jittered = self => modifyDelay(self, (_, delay) => effect.map(randomNext, random => {
@@ -1822,7 +1822,7 @@ export const jittered = self => modifyDelay(self, (_, delay) => effect.map(rando
  * })
  * ```
  *
- * @category utils
+ * @category mapping
  * @since 2.0.0
  */
 export const passthrough = self => fromStep(effect.map(toStep(self), step => (now, input) => Pull.matchEffect(step(now, input), {
@@ -2013,7 +2013,7 @@ export const recurs = times => while_(forever, ({
  * })
  * ```
  *
- * @category utils
+ * @category folding
  * @since 2.0.0
  */
 export const reduce = /*#__PURE__*/dual(3, (self, initial, combine) => fromStep(effect.map(toStep(self), step => {
@@ -2447,7 +2447,7 @@ export const tapOutput = /*#__PURE__*/dual(2, (self, f) => fromStep(effect.map(t
  *
  * @see {@link recurs} for creating a count-limited schedule
  *
- * @category utils
+ * @category taking
  * @since 4.0.0
  */
 export const take = /*#__PURE__*/dual(2, (self, n) => while_(self, ({
@@ -2587,7 +2587,7 @@ export {
  * @see {@link collectWhile} for collecting outputs while using the same predicate
  * @see {@link take} for stopping after a fixed number of schedule outputs
  *
- * @category utils
+ * @category filtering
  * @since 4.0.0
  */
 while_ as while };