effect 4.0.0-beta.29 → 4.0.0-beta.30

package/dist/Effect.d.ts

@@ -1599,8 +1599,13 @@ undefined_ as undefined };
  *
  * **When to Use**
  *
- * Use `Effect.async` when dealing with APIs that use callback-style instead of
+ * Use `Effect.callback` when dealing with APIs that use callback-style instead of
  * `async/await` or `Promise`.
+ * * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Effect.async`
  *
  * @example
  * ```ts
@@ -6816,7 +6821,8 @@ export declare const sandbox: <A, E, R>(self: Effect<A, E, R>) => Effect<A, Caus
  * it succeeds or fails. This is useful when you only care about the side
  * effects of the effect and do not need to handle or process its outcome.
  *
- * Use the `log` option to emit the full {@link Cause} when the effect fails.
+ * Use the `log` option to emit the full {@link Cause} when the effect fails,
+ * and `message` to prepend a custom log message.
  *
  * @example
  * ```ts
@@ -6840,7 +6846,7 @@ export declare const sandbox: <A, E, R>(self: Effect<A, E, R>) => Effect<A, Caus
  * const task = Effect.fail("Uh oh!")
  *
  * const program = task.pipe(Effect.ignore({ log: true }))
- * const programWarn = task.pipe(Effect.ignore({ log: "Warn" }))
+ * const programWarn = task.pipe(Effect.ignore({ log: "Warn", message: "Ignoring task failure" }))
  * ```
  *
  * **Previously Known As**
@@ -6854,15 +6860,19 @@ export declare const sandbox: <A, E, R>(self: Effect<A, E, R>) => Effect<A, Caus
  */
 export declare const ignore: <Arg extends Effect<any, any, any> | {
     readonly log?: boolean | Severity | undefined;
+    readonly message?: string | undefined;
 } | undefined = {
     readonly log?: boolean | Severity | undefined;
+    readonly message?: string | undefined;
 }>(effectOrOptions?: Arg, options?: {
     readonly log?: boolean | Severity | undefined;
+    readonly message?: string | 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.
  *
- * Use the `log` option to emit the full {@link Cause} when the effect fails.
+ * Use the `log` option to emit the full {@link Cause} when the effect fails,
+ * and `message` to prepend a custom log message.
  *
  * @example
  * ```ts
@@ -6871,7 +6881,7 @@ export declare const ignore: <Arg extends Effect<any, any, any> | {
  * const task = Effect.fail("boom")
  *
  * const program = task.pipe(Effect.ignoreCause)
- * const programLog = task.pipe(Effect.ignoreCause({ log: true }))
+ * const programLog = task.pipe(Effect.ignoreCause({ log: true, message: "Ignoring failure cause" }))
  * ```
  *
  * @since 4.0.0
@@ -6879,10 +6889,13 @@ export declare const ignore: <Arg extends Effect<any, any, any> | {
  */
 export declare const ignoreCause: <Arg extends Effect<any, any, any> | {
     readonly log?: boolean | Severity | undefined;
+    readonly message?: string | undefined;
 } | undefined = {
     readonly log?: boolean | Severity | undefined;
+    readonly message?: string | undefined;
 }>(effectOrOptions?: Arg, options?: {
     readonly log?: boolean | Severity | undefined;
+    readonly message?: string | 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