effect 4.0.1 → 4.0.3

package/src/Runtime.ts

@@ -7,6 +7,7 @@
  * exit codes and already-reported failures. Application code usually calls the
  * platform-provided runner instead of using this module directly.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import * as Cause from "effect/Cause"
@@ -54,6 +55,7 @@ import type * as Fiber from "./Fiber.ts"
  * await completed // => [Exit.succeed("Hello, World!"), 0]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -102,6 +104,7 @@ export interface Teardown {
  *
  * @see {@link errorExitCode} for customizing failure exit codes
  *
+ * @stability stable
  * @category running
  * @since 4.0.0
  */
@@ -175,6 +178,7 @@ export const defaultTeardown: Teardown = <E, A>(
  * events // => ["Starting program", "Program completed", "Custom teardown logic"]
  * ```
  *
+ * @stability stable
  * @category running
  * @since 4.0.0
  */
@@ -238,6 +242,7 @@ declare global {
  * Use to type properties keyed by `Runtime.errorExitCode` on custom error
  * values.
  *
+ * @stability stable
  * @category symbols
  * @since 4.0.0
  */
@@ -279,6 +284,7 @@ export type errorExitCode = "~effect/Runtime/errorExitCode"
  * @see {@link defaultTeardown} for the default failure exit-code rules that read this marker
  * @see {@link getErrorExitCode} for reading the marker from unknown error values
  *
+ * @stability stable
  * @category symbols
  * @since 4.0.0
  */
@@ -305,6 +311,7 @@ export const errorExitCode: errorExitCode = "~effect/Runtime/errorExitCode"
  *
  * @see {@link errorExitCode} for the marker read by this function
  *
+ * @stability stable
  * @category getters
  * @since 4.0.0
  */
@@ -326,6 +333,7 @@ export const getErrorExitCode = (u: unknown): number => {
  * Use to type properties keyed by `Runtime.errorReported` on custom error
  * values.
  *
+ * @stability stable
  * @category symbols
  * @since 4.0.0
  */
@@ -368,6 +376,7 @@ export type errorReported = "~effect/Runtime/errorReported"
  * @see {@link errorExitCode} for controlling failure exit codes
  * @see {@link getErrorReported} for reading the marker from unknown error values
  *
+ * @stability stable
  * @category symbols
  * @since 4.0.0
  */
@@ -393,6 +402,7 @@ export const errorReported: errorReported = "~effect/Runtime/errorReported"
  *
  * @see {@link errorReported} for the marker read by this function
  *
+ * @stability stable
  * @category getters
  * @since 4.0.0
  */

package/src/Schedule.ts

@@ -6,6 +6,7 @@
  * next step. Schedules are used by retry, repeat, stream, and channel APIs to
  * decide when work should continue, how long to wait, and when to stop.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import type { NonEmptyReadonlyArray } from "./Array.ts"
@@ -47,6 +48,7 @@ const randomNext: Effect<number> = random.Random.useSync((random) => random.next
  * await Effect.runPromise(Effect.provide(program, TestClock.layer())) // => [1, 2, 3]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -57,6 +59,7 @@ export interface Schedule<out Output, in Input = unknown, out Error = never, out
 /**
  * Metadata provided to schedule functions containing timing and input information.
  *
+ * @stability stable
  * @category metadata
  * @since 4.0.0
  */
@@ -72,6 +75,7 @@ export interface InputMetadata<Input> {
 /**
  * Extended metadata that includes both input metadata and the output value from the schedule.
  *
+ * @stability stable
  * @category metadata
  * @since 4.0.0
  */
@@ -90,6 +94,7 @@ export interface Metadata<Output = unknown, Input = unknown> extends InputMetada
  * input and output values, zero duration, and zeroed timing fields before any
  * schedule step has produced metadata.
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -109,6 +114,7 @@ export const CurrentMetadata = Context.Reference<Metadata>("effect/Schedule/Curr
 /**
  * The Schedule namespace contains types and utilities for working with schedules.
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace Schedule {
@@ -154,6 +160,7 @@ export declare namespace Schedule {
 /**
  * Extracts the output type from a `Schedule`.
  *
+ * @stability stable
  * @category utility types
  * @since 4.0.0
  */
@@ -162,6 +169,7 @@ export type Output<S> = S extends Schedule<infer Output, any, any, any> ? Output
 /**
  * Extracts the input type from a `Schedule`.
  *
+ * @stability stable
  * @category utility types
  * @since 4.0.0
  */
@@ -170,6 +178,7 @@ export type Input<S> = S extends Schedule<any, infer Input, any, any> ? Input :
 /**
  * Extracts the error type from a `Schedule`.
  *
+ * @stability stable
  * @category utility types
  * @since 4.0.0
  */
@@ -178,6 +187,7 @@ export type Error<S> = S extends Schedule<any, any, infer Error, any> ? Error :
 /**
  * Extracts the service requirements from a `Schedule`.
  *
+ * @stability stable
  * @category utility types
  * @since 4.0.0
  */
@@ -211,6 +221,7 @@ const ScheduleProto = {
  * Schedule.isSchedule(undefined) // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -244,6 +255,7 @@ export const isSchedule = (u: unknown): u is Schedule<unknown, never, unknown, u
  * await Effect.runPromise(program) // => 0
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -300,6 +312,7 @@ const metadataFn = () => {
  * await Effect.runPromise(program) // => "attempt 1: input"
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -338,6 +351,7 @@ export const fromStepWithMetadata = <Input, Output, EnvX, ErrorX, Error, Env>(
  * await Effect.runPromise(program) // => [Duration.millis(100), Duration.millis(100)]
  * ```
  *
+ * @stability stable
  * @category destructors
  * @since 4.0.0
  */
@@ -371,6 +385,7 @@ export const toStep = <Output, Input, Error, Env>(
  * @see {@link toStep} for manually supplying the timestamp and handling the returned delay yourself
  * @see {@link toStepWithSleep} for the same automatic sleeping behavior when only the schedule output is needed
  *
+ * @stability stable
  * @category destructors
  * @since 4.0.0
  */
@@ -423,6 +438,7 @@ export const toStepWithMetadata = <Output, Input, Error, Env>(
  * await Effect.runPromise(Effect.provide(program, TestClock.layer())) // => [0, 1]
  * ```
  *
+ * @stability stable
  * @category destructors
  * @since 4.0.0
  */
@@ -459,6 +475,7 @@ export const toStepWithSleep = <Output, Input, Error, Env>(
  * await Effect.runPromise(program) // => Duration.millis(25)
  * ```
  *
+ * @stability stable
  * @category delays & timeouts
  * @since 2.0.0
  */
@@ -484,6 +501,7 @@ export const addDelay: {
    * await Effect.runPromise(program) // => Duration.millis(25)
    * ```
    *
+   * @stability stable
    * @category delays & timeouts
    * @since 2.0.0
    */
@@ -513,6 +531,7 @@ export const addDelay: {
    * await Effect.runPromise(program) // => Duration.millis(25)
    * ```
    *
+   * @stability stable
    * @category delays & timeouts
    * @since 2.0.0
    */
@@ -542,6 +561,7 @@ export const addDelay: {
  * Schedule.isSchedule(schedule) // => true
  * ```
  *
+ * @stability stable
  * @category sequencing
  * @since 2.0.0
  */
@@ -559,6 +579,7 @@ export const concat: {
    * Schedule.isSchedule(schedule) // => true
    * ```
    *
+   * @stability stable
    * @category sequencing
    * @since 2.0.0
    */
@@ -578,6 +599,7 @@ export const concat: {
    * Schedule.isSchedule(schedule) // => true
    * ```
    *
+   * @stability stable
    * @category sequencing
    * @since 2.0.0
    */
@@ -610,6 +632,7 @@ export const concat: {
  * Schedule.isSchedule(schedule) // => true
  * ```
  *
+ * @stability stable
  * @category sequencing
  * @since 4.0.0
  */
@@ -633,6 +656,7 @@ export const concatResult: {
    * Schedule.isSchedule(schedule) // => true
    * ```
    *
+   * @stability stable
    * @category sequencing
    * @since 4.0.0
    */
@@ -658,6 +682,7 @@ export const concatResult: {
    * Schedule.isSchedule(schedule) // => true
    * ```
    *
+   * @stability stable
    * @category sequencing
    * @since 4.0.0
    */
@@ -711,6 +736,7 @@ export const concatResult: {
          * Schedule.isSchedule(schedule) // => true
          * ```
          *
+         * @stability stable
          * @category sequencing
          * @since 4.0.0
          */
@@ -734,6 +760,7 @@ export const concatResult: {
          * Schedule.isSchedule(schedule) // => true
          * ```
          *
+         * @stability stable
          * @category sequencing
          * @since 4.0.0
          */
@@ -757,6 +784,7 @@ export const concatResult: {
          * Schedule.isSchedule(schedule) // => true
          * ```
          *
+         * @stability stable
          * @category sequencing
          * @since 4.0.0
          */
@@ -780,6 +808,7 @@ export const concatResult: {
          * Schedule.isSchedule(schedule) // => true
          * ```
          *
+         * @stability stable
          * @category sequencing
          * @since 4.0.0
          */
@@ -820,6 +849,7 @@ export const concatResult: {
  * Schedule.isSchedule(schedule) // => true
  * ```
  *
+ * @stability stable
  * @category combining
  * @since 4.0.0
  */
@@ -880,6 +910,7 @@ const maxDuration = (results: ReadonlyArray<Duration.Duration | undefined>): Dur
  * Schedule.isSchedule(everyMinute) // => true
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -897,6 +928,7 @@ export const cron: {
    * Schedule.isSchedule(everyMinute) // => true
    * ```
    *
+   * @stability stable
    * @category constructors
    * @since 2.0.0
    */
@@ -914,6 +946,7 @@ export const cron: {
    * Schedule.isSchedule(everyMinute) // => true
    * ```
    *
+   * @stability stable
    * @category constructors
    * @since 2.0.0
    */
@@ -954,6 +987,7 @@ export const cron: {
  *
  * @see {@link during} for recurring until a duration has elapsed
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -984,6 +1018,7 @@ export const duration = (durationInput: Duration.Input): Schedule<Duration.Durat
  *
  * @see {@link duration} for one delayed recurrence
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -1017,6 +1052,7 @@ export const during = (duration: Duration.Input): Schedule<Duration.Duration> =>
  * Schedule.isSchedule(schedule) // => true
  * ```
  *
+ * @stability stable
  * @category combining
  * @since 4.0.0
  */
@@ -1084,6 +1120,7 @@ const minDuration = (results: ReadonlyArray<Duration.Duration | undefined>): Dur
  * await Effect.runPromise(program) // => [Duration.millis(100), Duration.millis(100)]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1116,6 +1153,7 @@ export const exponential = (
  * await Effect.runPromise(program) // => [Duration.millis(100), Duration.millis(100)]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1167,6 +1205,7 @@ export const fibonacci = (one: Duration.Input): Schedule<Duration.Duration> => {
  *
  * @see {@link spaced} for delaying after each action completes
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1221,6 +1260,7 @@ export const fixed = (interval: Duration.Input): Schedule<number> => {
  * await Effect.runPromise(program) // => "Execution #1"
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -1252,6 +1292,7 @@ export const map: {
    * await Effect.runPromise(program) // => "Execution #1"
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 2.0.0
    */
@@ -1287,6 +1328,7 @@ export const map: {
    * await Effect.runPromise(program) // => "Execution #1"
    * ```
    *
+   * @stability stable
    * @category mapping
    * @since 2.0.0
    */
@@ -1337,6 +1379,7 @@ export const map: {
  * await Effect.runPromise(program) // => Duration.millis(20)
  * ```
  *
+ * @stability stable
  * @category delays & timeouts
  * @since 2.0.0
  */
@@ -1362,6 +1405,7 @@ export const modifyDelay: {
    * await Effect.runPromise(program) // => Duration.millis(20)
    * ```
    *
+   * @stability stable
    * @category delays & timeouts
    * @since 2.0.0
    */
@@ -1393,6 +1437,7 @@ export const modifyDelay: {
    * await Effect.runPromise(program) // => Duration.millis(20)
    * ```
    *
+   * @stability stable
    * @category delays & timeouts
    * @since 2.0.0
    */
@@ -1435,6 +1480,7 @@ export const modifyDelay: {
  *
  * @see {@link modifyDelay} for replacing recurrence delays with a custom effectful transformation
  *
+ * @stability stable
  * @category delays & timeouts
  * @since 2.0.0
  */
@@ -1467,6 +1513,7 @@ export const jittered = <Output, Input, Error, Env>(
  * await Effect.runPromise(program) // => "input"
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 2.0.0
  */
@@ -1511,6 +1558,7 @@ export const passthrough = <Output, Input, Error, Env>(
  *
  * @see {@link upTo} for limiting an existing schedule
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1540,6 +1588,7 @@ export const recurs = (times: number): Schedule<number> =>
  *
  * @see {@link fixed} for recurrence aligned to a regular cadence
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1576,6 +1625,7 @@ export const spaced = (duration: Duration.Input): Schedule<number> => {
  * await Effect.runPromise(program) // => { attempts: [1], output: 0 }
  * ```
  *
+ * @stability stable
  * @category sequencing
  * @since 4.0.0
  */
@@ -1608,6 +1658,7 @@ export const tap: {
    * await Effect.runPromise(program) // => { attempts: [1], output: 0 }
    * ```
    *
+   * @stability stable
    * @category sequencing
    * @since 4.0.0
    */
@@ -1642,6 +1693,7 @@ export const tap: {
    * await Effect.runPromise(program) // => { attempts: [1], output: 0 }
    * ```
    *
+   * @stability stable
    * @category sequencing
    * @since 4.0.0
    */
@@ -1696,6 +1748,7 @@ export const tap: {
  * await Effect.runPromise(Effect.provide(program, TestClock.layer())) // => [1, 2, 3]
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 4.0.0
  */
@@ -1737,6 +1790,7 @@ export const upTo: {
    * await Effect.runPromise(Effect.provide(program, TestClock.layer())) // => [1, 2, 3]
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 4.0.0
    */
@@ -1785,6 +1839,7 @@ export const upTo: {
    * await Effect.runPromise(Effect.provide(program, TestClock.layer())) // => [1, 2, 3]
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 4.0.0
    */
@@ -1873,6 +1928,7 @@ export {
    *
    * @see {@link upTo} for stopping after a fixed number of schedule outputs
    *
+   * @stability stable
    * @category filtering
    * @since 4.0.0
    */
@@ -1907,6 +1963,7 @@ export {
  * await Effect.runPromise(program) // => [0, Duration.seconds(5)]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1944,6 +2001,7 @@ export const windowed = (interval: Duration.Input): Schedule<number> => {
  * await Effect.runPromise(Effect.provide(program, TestClock.layer())) // => [1, 2, 3]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1958,6 +2016,7 @@ export const forever: Schedule<number> = spaced(Duration.zero)
  * `Effect.repeat`, the effect runs twice in total: once initially and once
  * after the schedule recurs.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -1985,6 +2044,7 @@ export {
    * echoes its input values at each step.
    *
    * @see {@link forever} for an infinite schedule that returns incrementing step counts
+   * @stability stable
    * @category constructors
    * @since 2.0.0
    */
@@ -2014,6 +2074,7 @@ export {
  * Schedule.isSchedule(schedule) // => true
  * ```
  *
+ * @stability stable
  * @category utility types
  * @since 4.0.0
  */

package/src/Scheduler.ts

@@ -7,6 +7,7 @@
  * for queued tasks, and references for tuning or disabling automatic scheduler
  * yields.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as Context from "./Context.ts"
@@ -26,6 +27,7 @@ import type * as Fiber from "./Fiber.ts"
  * priorities, and decides when fibers should yield control after consuming
  * their operation budget.
  *
+ * @stability stable
  * @category services
  * @since 2.0.0
  */
@@ -51,6 +53,7 @@ export interface Scheduler {
  * already scheduled tasks. Lower priority numbers run first, and equal
  * priorities run in FIFO order.
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -72,6 +75,7 @@ export interface SchedulerDispatcher {
  * The default value creates a `MixedScheduler`. Provide this service to
  * customize execution mode, task dispatching, or yield behavior.
  *
+ * @stability stable
  * @category services
  * @since 2.0.0
  */
@@ -156,6 +160,7 @@ class PriorityBuckets {
  * operation counts to decide when fibers should yield, and is the default
  * scheduler implementation.
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -273,6 +278,7 @@ class MixedSchedulerDispatcher implements SchedulerDispatcher {
  *
  * @see {@link PreventSchedulerYield} for bypassing scheduler yield checks entirely rather than tuning the operation budget
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -299,6 +305,7 @@ export const MaxOpsBeforeYield = Context.Reference<number>("effect/Scheduler/Max
  * @see {@link MaxOpsBeforeYield} for tuning yield frequency without disabling yield checks
  * @see {@link Scheduler} for providing custom scheduler yield behavior
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */