effect 4.0.0-beta.10 → 4.0.0-beta.12

package/dist/Effect.d.ts

@@ -78,7 +78,7 @@ import { type LazyArg } from "./Function.ts";
 import type { TypeLambda } from "./HKT.ts";
 import type * as Layer from "./Layer.ts";
 import type { Logger } from "./Logger.ts";
-import type { LogLevel } from "./LogLevel.ts";
+import type { Severity } from "./LogLevel.ts";
 import * as Metric from "./Metric.ts";
 import type { Option } from "./Option.ts";
 import type { Pipeable } from "./Pipeable.ts";
@@ -724,6 +724,199 @@ export declare const partition: {
         readonly concurrency?: Concurrency | undefined;
     }): Effect<[excluded: Array<E>, satisfying: Array<B>], never, R>;
 };
+/**
+ * Applies an effectful function to each element and accumulates all failures.
+ *
+ * This function always evaluates every element. If at least one effect fails,
+ * all failures are returned as a non-empty array and successes are discarded.
+ * If all effects succeed, it returns all collected successes.
+ *
+ * Use `discard: true` to ignore successful values while still validating all
+ * elements.
+ *
+ * @example
+ * ```ts
+ * import { Effect } from "effect"
+ *
+ * const program = Effect.validate([0, 1, 2, 3], (n) =>
+ *   n % 2 === 0 ? Effect.fail(`${n} is even`) : Effect.succeed(n)
+ * )
+ *
+ * Effect.runPromiseExit(program).then(console.log)
+ * // {
+ * //   _id: 'Exit',
+ * //   _tag: 'Failure',
+ * //   cause: {
+ * //     _id: 'Cause',
+ * //     reasons: [
+ * //       { _id: 'Reason', _tag: 'Fail', error: '0 is even' },
+ * //       { _id: 'Reason', _tag: 'Fail', error: '2 is even' }
+ * //     ]
+ * //   }
+ * // }
+ * ```
+ *
+ * @since 4.0.0
+ * @category Error Accumulation
+ */
+export declare const validate: {
+    /**
+     * Applies an effectful function to each element and accumulates all failures.
+     *
+     * This function always evaluates every element. If at least one effect fails,
+     * all failures are returned as a non-empty array and successes are discarded.
+     * If all effects succeed, it returns all collected successes.
+     *
+     * Use `discard: true` to ignore successful values while still validating all
+     * elements.
+     *
+     * @example
+     * ```ts
+     * import { Effect } from "effect"
+     *
+     * const program = Effect.validate([0, 1, 2, 3], (n) =>
+     *   n % 2 === 0 ? Effect.fail(`${n} is even`) : Effect.succeed(n)
+     * )
+     *
+     * Effect.runPromiseExit(program).then(console.log)
+     * // {
+     * //   _id: 'Exit',
+     * //   _tag: 'Failure',
+     * //   cause: {
+     * //     _id: 'Cause',
+     * //     reasons: [
+     * //       { _id: 'Reason', _tag: 'Fail', error: '0 is even' },
+     * //       { _id: 'Reason', _tag: 'Fail', error: '2 is even' }
+     * //     ]
+     * //   }
+     * // }
+     * ```
+     *
+     * @since 4.0.0
+     * @category Error Accumulation
+     */
+    <A, B, E, R>(f: (a: A, i: number) => Effect<B, E, R>, options?: {
+        readonly concurrency?: Concurrency | undefined;
+        readonly discard?: false | undefined;
+    } | undefined): (elements: Iterable<A>) => Effect<Array<B>, Arr.NonEmptyArray<E>, R>;
+    /**
+     * Applies an effectful function to each element and accumulates all failures.
+     *
+     * This function always evaluates every element. If at least one effect fails,
+     * all failures are returned as a non-empty array and successes are discarded.
+     * If all effects succeed, it returns all collected successes.
+     *
+     * Use `discard: true` to ignore successful values while still validating all
+     * elements.
+     *
+     * @example
+     * ```ts
+     * import { Effect } from "effect"
+     *
+     * const program = Effect.validate([0, 1, 2, 3], (n) =>
+     *   n % 2 === 0 ? Effect.fail(`${n} is even`) : Effect.succeed(n)
+     * )
+     *
+     * Effect.runPromiseExit(program).then(console.log)
+     * // {
+     * //   _id: 'Exit',
+     * //   _tag: 'Failure',
+     * //   cause: {
+     * //     _id: 'Cause',
+     * //     reasons: [
+     * //       { _id: 'Reason', _tag: 'Fail', error: '0 is even' },
+     * //       { _id: 'Reason', _tag: 'Fail', error: '2 is even' }
+     * //     ]
+     * //   }
+     * // }
+     * ```
+     *
+     * @since 4.0.0
+     * @category Error Accumulation
+     */
+    <A, B, E, R>(f: (a: A, i: number) => Effect<B, E, R>, options: {
+        readonly concurrency?: Concurrency | undefined;
+        readonly discard: true;
+    }): (elements: Iterable<A>) => Effect<void, Arr.NonEmptyArray<E>, R>;
+    /**
+     * Applies an effectful function to each element and accumulates all failures.
+     *
+     * This function always evaluates every element. If at least one effect fails,
+     * all failures are returned as a non-empty array and successes are discarded.
+     * If all effects succeed, it returns all collected successes.
+     *
+     * Use `discard: true` to ignore successful values while still validating all
+     * elements.
+     *
+     * @example
+     * ```ts
+     * import { Effect } from "effect"
+     *
+     * const program = Effect.validate([0, 1, 2, 3], (n) =>
+     *   n % 2 === 0 ? Effect.fail(`${n} is even`) : Effect.succeed(n)
+     * )
+     *
+     * Effect.runPromiseExit(program).then(console.log)
+     * // {
+     * //   _id: 'Exit',
+     * //   _tag: 'Failure',
+     * //   cause: {
+     * //     _id: 'Cause',
+     * //     reasons: [
+     * //       { _id: 'Reason', _tag: 'Fail', error: '0 is even' },
+     * //       { _id: 'Reason', _tag: 'Fail', error: '2 is even' }
+     * //     ]
+     * //   }
+     * // }
+     * ```
+     *
+     * @since 4.0.0
+     * @category Error Accumulation
+     */
+    <A, B, E, R>(elements: Iterable<A>, f: (a: A, i: number) => Effect<B, E, R>, options?: {
+        readonly concurrency?: Concurrency | undefined;
+        readonly discard?: false | undefined;
+    } | undefined): Effect<Array<B>, Arr.NonEmptyArray<E>, R>;
+    /**
+     * Applies an effectful function to each element and accumulates all failures.
+     *
+     * This function always evaluates every element. If at least one effect fails,
+     * all failures are returned as a non-empty array and successes are discarded.
+     * If all effects succeed, it returns all collected successes.
+     *
+     * Use `discard: true` to ignore successful values while still validating all
+     * elements.
+     *
+     * @example
+     * ```ts
+     * import { Effect } from "effect"
+     *
+     * const program = Effect.validate([0, 1, 2, 3], (n) =>
+     *   n % 2 === 0 ? Effect.fail(`${n} is even`) : Effect.succeed(n)
+     * )
+     *
+     * Effect.runPromiseExit(program).then(console.log)
+     * // {
+     * //   _id: 'Exit',
+     * //   _tag: 'Failure',
+     * //   cause: {
+     * //     _id: 'Cause',
+     * //     reasons: [
+     * //       { _id: 'Reason', _tag: 'Fail', error: '0 is even' },
+     * //       { _id: 'Reason', _tag: 'Fail', error: '2 is even' }
+     * //     ]
+     * //   }
+     * // }
+     * ```
+     *
+     * @since 4.0.0
+     * @category Error Accumulation
+     */
+    <A, B, E, R>(elements: Iterable<A>, f: (a: A, i: number) => Effect<B, E, R>, options: {
+        readonly concurrency?: Concurrency | undefined;
+        readonly discard: true;
+    }): Effect<void, Arr.NonEmptyArray<E>, R>;
+};
 /**
  * Executes an effectful operation for each element in an `Iterable`.
  *
@@ -6421,11 +6614,11 @@ export declare const sandbox: <A, E, R>(self: Effect<A, E, R>) => Effect<A, Caus
  * @category Error Handling
  */
 export declare const ignore: <Arg extends Effect<any, any, any> | {
-    readonly log?: boolean | LogLevel | undefined;
+    readonly log?: boolean | Severity | undefined;
 } | undefined = {
-    readonly log?: boolean | LogLevel | undefined;
+    readonly log?: boolean | Severity | undefined;
 }>(effectOrOptions?: Arg, options?: {
-    readonly log?: boolean | LogLevel | undefined;
+    readonly log?: boolean | Severity | undefined;
 } | undefined) => [Arg] extends [Effect<infer _A, infer _E, infer _R>] ? Effect<void, never, _R> : <A, E, R>(self: Effect<A, E, R>) => Effect<void, never, R>;
 /**
  * Ignores the effect's failure cause, including defects and interruptions.
@@ -6446,11 +6639,11 @@ export declare const ignore: <Arg extends Effect<any, any, any> | {
  * @category Error Handling
  */
 export declare const ignoreCause: <Arg extends Effect<any, any, any> | {
-    readonly log?: boolean | LogLevel | undefined;
+    readonly log?: boolean | Severity | undefined;
 } | undefined = {
-    readonly log?: boolean | LogLevel | undefined;
+    readonly log?: boolean | Severity | undefined;
 }>(effectOrOptions?: Arg, options?: {
-    readonly log?: boolean | LogLevel | undefined;
+    readonly log?: boolean | Severity | undefined;
 } | undefined) => [Arg] extends [Effect<infer _A, infer _E, infer _R>] ? Effect<void, never, _R> : <A, E, R>(self: Effect<A, E, R>) => Effect<void, never, R>;
 /**
  * Apply an `ExecutionPlan` to an effect, retrying with step-provided resources
@@ -6556,6 +6749,22 @@ export declare const withExecutionPlan: {
         requirements: PlanR;
     }>): Effect<A, E | PlanE, Exclude<R, Provides> | PlanR>;
 };
+/**
+ * Runs an effect and reports any errors to the configured `ErrorReporter`s.
+ *
+ * If the `defectsOnly` option is set to `true`, only defects (unrecoverable
+ * errors) will be reported, while regular failures will be ignored.
+ *
+ * @since 4.0.0
+ * @category Error Handling
+ */
+export declare const withErrorReporting: <Arg extends Effect<any, any, any> | {
+    readonly defectsOnly?: boolean | undefined;
+} | undefined = {
+    readonly defectsOnly?: boolean | undefined;
+}>(effectOrOptions: Arg, options?: {
+    readonly defectsOnly?: boolean | undefined;
+} | undefined) => [Arg] extends [Effect<infer _A, infer _E, infer _R>] ? Arg : <A, E, R>(self: Effect<A, E, R>) => Effect<A, E, R>;
 /**
  * Replaces the original failure with a success value, ensuring the effect
  * cannot fail.
@@ -15630,7 +15839,7 @@ export declare const clockWith: <A, E, R>(f: (clock: Clock) => Effect<A, E, R>)
  * @since 2.0.0
  * @category Logging
  */
-export declare const logWithLevel: (level?: LogLevel) => (...message: ReadonlyArray<any>) => Effect<void>;
+export declare const logWithLevel: (level?: Severity) => (...message: ReadonlyArray<any>) => Effect<void>;
 /**
  * Logs one or more messages using the default log level.
  *
@@ -15897,6 +16106,85 @@ export declare const annotateLogs: {
     <A, E, R>(effect: Effect<A, E, R>, key: string, value: unknown): Effect<A, E, R>;
     <A, E, R>(effect: Effect<A, E, R>, values: Record<string, unknown>): Effect<A, E, R>;
 };
+/**
+ * Adds log annotations to the current scope.
+ *
+ * This differs from `annotateLogs`, which only annotates a specific effect.
+ * `annotateLogsScoped` updates annotations for the entire current `Scope` and
+ * restores the previous annotations when the scope closes.
+ *
+ * @example
+ * ```ts
+ * import { Effect } from "effect"
+ *
+ * const program = Effect.scoped(
+ *   Effect.gen(function*() {
+ *     yield* Effect.log("before")
+ *     yield* Effect.annotateLogsScoped({ requestId: "req-123" })
+ *     yield* Effect.log("inside scope")
+ *   })
+ * )
+ *
+ * Effect.runPromise(program)
+ * ```
+ *
+ * @since 4.0.0
+ * @category Logging
+ */
+export declare const annotateLogsScoped: {
+    /**
+     * Adds log annotations to the current scope.
+     *
+     * This differs from `annotateLogs`, which only annotates a specific effect.
+     * `annotateLogsScoped` updates annotations for the entire current `Scope` and
+     * restores the previous annotations when the scope closes.
+     *
+     * @example
+     * ```ts
+     * import { Effect } from "effect"
+     *
+     * const program = Effect.scoped(
+     *   Effect.gen(function*() {
+     *     yield* Effect.log("before")
+     *     yield* Effect.annotateLogsScoped({ requestId: "req-123" })
+     *     yield* Effect.log("inside scope")
+     *   })
+     * )
+     *
+     * Effect.runPromise(program)
+     * ```
+     *
+     * @since 4.0.0
+     * @category Logging
+     */
+    (key: string, value: unknown): Effect<void, never, Scope>;
+    /**
+     * Adds log annotations to the current scope.
+     *
+     * This differs from `annotateLogs`, which only annotates a specific effect.
+     * `annotateLogsScoped` updates annotations for the entire current `Scope` and
+     * restores the previous annotations when the scope closes.
+     *
+     * @example
+     * ```ts
+     * import { Effect } from "effect"
+     *
+     * const program = Effect.scoped(
+     *   Effect.gen(function*() {
+     *     yield* Effect.log("before")
+     *     yield* Effect.annotateLogsScoped({ requestId: "req-123" })
+     *     yield* Effect.log("inside scope")
+     *   })
+     * )
+     *
+     * Effect.runPromise(program)
+     * ```
+     *
+     * @since 4.0.0
+     * @category Logging
+     */
+    (values: Record<string, unknown>): Effect<void, never, Scope>;
+};
 /**
  * Adds a span to each log line in this effect.
  *