effect 4.0.0-beta.25 → 4.0.0-beta.27

package/src/Effect.ts

@@ -2436,17 +2436,17 @@ export const fromOption: <A>(
  * ```ts
  * import { Console, Effect } from "effect"
  *
- * const input: string | null = null
- *
- * const program = Effect.gen(function*() {
+ * const program = Effect.fn(function*(input: string | null) {
  *   const value = yield* Effect.fromNullishOr(input)
  *   yield* Console.log(value)
- * }).pipe(
+ * },
  *   Effect.catch(() => Console.log("missing"))
  * )
  *
- * Effect.runPromise(program)
+ * Effect.runPromise(program(null))
  * // Output: missing
+ * Effect.runPromise(program("hello"))
+ * // Output: hello
  * ```
  *
  * @since 4.0.0
@@ -4394,7 +4394,8 @@ export const catchTag: {
  * once. Instead of using {@link catchTag} multiple times, you can pass an
  * object where each key is an error type's `_tag`, and the value is the handler
  * for that specific error. This allows you to catch and recover from multiple
- * error types in a single call.
+ * error types in a single call. You can also provide a fallback handler for
+ * unhandled errors.
  *
  * The error type must have a readonly `_tag` field to use `catchTag`. This
  * field is used to identify and match errors.
@@ -4436,7 +4437,8 @@ export const catchTags: {
    * once. Instead of using {@link catchTag} multiple times, you can pass an
    * object where each key is an error type's `_tag`, and the value is the handler
    * for that specific error. This allows you to catch and recover from multiple
-   * error types in a single call.
+   * error types in a single call. You can also provide a fallback handler for
+   * unhandled errors.
    *
    * The error type must have a readonly `_tag` field to use `catchTag`. This
    * field is used to identify and match errors.
@@ -4472,19 +4474,27 @@ export const catchTags: {
     E,
     Cases extends
       & { [K in Extract<E, { _tag: string }>["_tag"]]+?: ((error: Extract<E, { _tag: K }>) => Effect<any, any, any>) }
-      & (unknown extends E ? {} : { [K in Exclude<keyof Cases, Extract<E, { _tag: string }>["_tag"]>]: never })
-  >(cases: Cases): <A, R>(
+      & (unknown extends E ? {} : { [K in Exclude<keyof Cases, Extract<E, { _tag: string }>["_tag"]>]: never }),
+    A2 = never,
+    E2 = Exclude<E, { _tag: keyof Cases }>,
+    R2 = never
+  >(
+    cases: Cases,
+    orElse?: ((e: Exclude<E, { _tag: keyof Cases }>) => Effect<A2, E2, R2>) | undefined
+  ): <A, R>(
     self: Effect<A, E, R>
   ) => Effect<
     | A
+    | A2
     | {
       [K in keyof Cases]: Cases[K] extends (...args: Array<any>) => Effect<infer A, any, any> ? A : never
     }[keyof Cases],
-    | Exclude<E, { _tag: keyof Cases }>
+    | E2
     | {
       [K in keyof Cases]: Cases[K] extends (...args: Array<any>) => Effect<any, infer E, any> ? E : never
     }[keyof Cases],
     | R
+    | R2
     | {
       [K in keyof Cases]: Cases[K] extends (...args: Array<any>) => Effect<any, any, infer R> ? R : never
     }[keyof Cases]
@@ -4498,7 +4508,8 @@ export const catchTags: {
    * once. Instead of using {@link catchTag} multiple times, you can pass an
    * object where each key is an error type's `_tag`, and the value is the handler
    * for that specific error. This allows you to catch and recover from multiple
-   * error types in a single call.
+   * error types in a single call. You can also provide a fallback handler for
+   * unhandled errors.
    *
    * The error type must have a readonly `_tag` field to use `catchTag`. This
    * field is used to identify and match errors.
@@ -4536,17 +4547,26 @@ export const catchTags: {
     A,
     Cases extends
       & { [K in Extract<E, { _tag: string }>["_tag"]]+?: ((error: Extract<E, { _tag: K }>) => Effect<any, any, any>) }
-      & (unknown extends E ? {} : { [K in Exclude<keyof Cases, Extract<E, { _tag: string }>["_tag"]>]: never })
-  >(self: Effect<A, E, R>, cases: Cases): Effect<
+      & (unknown extends E ? {} : { [K in Exclude<keyof Cases, Extract<E, { _tag: string }>["_tag"]>]: never }),
+    A2 = never,
+    E2 = Exclude<E, { _tag: keyof Cases }>,
+    R2 = never
+  >(
+    self: Effect<A, E, R>,
+    cases: Cases,
+    orElse?: ((e: Exclude<E, { _tag: keyof Cases }>) => Effect<A2, E2, R2>) | undefined
+  ): Effect<
     | A
+    | A2
     | {
       [K in keyof Cases]: Cases[K] extends (...args: Array<any>) => Effect<infer A, any, any> ? A : never
     }[keyof Cases],
-    | Exclude<E, { _tag: keyof Cases }>
+    | E2
     | {
       [K in keyof Cases]: Cases[K] extends (...args: Array<any>) => Effect<any, infer E, any> ? E : never
     }[keyof Cases],
     | R
+    | R2
     | {
       [K in keyof Cases]: Cases[K] extends (...args: Array<any>) => Effect<any, any, infer R> ? R : never
     }[keyof Cases]
@@ -6636,7 +6656,7 @@ export const tapDefect: {
  *   attempts++
  *   yield* Console.log(`Attempt ${attempts}`)
  *   if (attempts < 3) {
- *     yield* Effect.fail("Not ready")
+ *     return yield* Effect.fail("Not ready")
  *   }
  *   return "Ready"
  * })
@@ -7413,7 +7433,10 @@ export const ignoreCause: <
  *
  * const fetchUrl = Effect.gen(function*() {
  *   const endpoint = yield* Effect.service(Endpoint)
- *   return endpoint.url === "bad" ? yield* Effect.fail("Unavailable") : endpoint.url
+ *   if (endpoint.url === "bad") {
+ *     return yield* Effect.fail("Unavailable")
+ *   }
+ *   return endpoint.url
  * })
  *
  * const plan = ExecutionPlan.make(
@@ -7444,7 +7467,10 @@ export const withExecutionPlan: {
    *
    * const fetchUrl = Effect.gen(function*() {
    *   const endpoint = yield* Effect.service(Endpoint)
-   *   return endpoint.url === "bad" ? yield* Effect.fail("Unavailable") : endpoint.url
+   *   if (endpoint.url === "bad") {
+   *     return yield* Effect.fail("Unavailable")
+   *   }
+   *   return endpoint.url
    * })
    *
    * const plan = ExecutionPlan.make(
@@ -7479,7 +7505,10 @@ export const withExecutionPlan: {
    *
    * const fetchUrl = Effect.gen(function*() {
    *   const endpoint = yield* Effect.service(Endpoint)
-   *   return endpoint.url === "bad" ? yield* Effect.fail("Unavailable") : endpoint.url
+   *   if (endpoint.url === "bad") {
+   *     return yield* Effect.fail("Unavailable")
+   *   }
+   *   return endpoint.url
    * })
    *
    * const plan = ExecutionPlan.make(
@@ -10420,7 +10449,7 @@ export const isSuccess: <A, E, R>(self: Effect<A, E, R>) => Effect<boolean, neve
  * @since 2.0.0
  * @category Environment
  */
-export const services: <R>() => Effect<ServiceMap.ServiceMap<R>, never, R> = internal.services
+export const services: <R = never>() => Effect<ServiceMap.ServiceMap<R>, never, R> = internal.services
 
 /**
  * Transforms the current service map using the provided function.
@@ -10486,7 +10515,7 @@ export const servicesWith: <R, A, E, R2>(
  * const Database = ServiceMap.Service<Database>("Database")
  *
  * const DatabaseLive = Layer.succeed(Database)({
- *   query: (sql: string) => Effect.succeed(`Result for: ${sql}`)
+ *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed(`Result for: ${sql}`))
  * })
  *
  * const program = Effect.gen(function*() {
@@ -10520,7 +10549,7 @@ export const provide: {
    * const Database = ServiceMap.Service<Database>("Database")
    *
    * const DatabaseLive = Layer.succeed(Database)({
-   *   query: (sql: string) => Effect.succeed(`Result for: ${sql}`)
+   *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed(`Result for: ${sql}`))
    * })
    *
    * const program = Effect.gen(function*() {
@@ -10565,7 +10594,7 @@ export const provide: {
    * const Database = ServiceMap.Service<Database>("Database")
    *
    * const DatabaseLive = Layer.succeed(Database)({
-   *   query: (sql: string) => Effect.succeed(`Result for: ${sql}`)
+   *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed(`Result for: ${sql}`))
    * })
    *
    * const program = Effect.gen(function*() {
@@ -10606,7 +10635,7 @@ export const provide: {
    * const Database = ServiceMap.Service<Database>("Database")
    *
    * const DatabaseLive = Layer.succeed(Database)({
-   *   query: (sql: string) => Effect.succeed(`Result for: ${sql}`)
+   *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed(`Result for: ${sql}`))
    * })
    *
    * const program = Effect.gen(function*() {
@@ -10640,7 +10669,7 @@ export const provide: {
    * const Database = ServiceMap.Service<Database>("Database")
    *
    * const DatabaseLive = Layer.succeed(Database)({
-   *   query: (sql: string) => Effect.succeed(`Result for: ${sql}`)
+   *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed(`Result for: ${sql}`))
    * })
    *
    * const program = Effect.gen(function*() {
@@ -10684,7 +10713,7 @@ export const provide: {
    * const Database = ServiceMap.Service<Database>("Database")
    *
    * const DatabaseLive = Layer.succeed(Database)({
-   *   query: (sql: string) => Effect.succeed(`Result for: ${sql}`)
+   *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed(`Result for: ${sql}`))
    * })
    *
    * const program = Effect.gen(function*() {
@@ -10724,7 +10753,7 @@ export const provide: {
    * const Database = ServiceMap.Service<Database>("Database")
    *
    * const DatabaseLive = Layer.succeed(Database)({
-   *   query: (sql: string) => Effect.succeed(`Result for: ${sql}`)
+   *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed(`Result for: ${sql}`))
    * })
    *
    * const program = Effect.gen(function*() {
@@ -13004,8 +13033,8 @@ export const cachedInvalidateWithTTL: {
  * import { Effect } from "effect"
  *
  * const program = Effect.gen(function*() {
- *   yield* Effect.interrupt
- *   yield* Effect.succeed("This won't execute")
+ *   return yield* Effect.interrupt
+ *   yield* Effect.succeed("This won't execute and is unreachable")
  * })
  *
  * Effect.runPromise(program).catch(console.error)
@@ -13832,7 +13861,7 @@ export const repeat: {
  *   attempt++
  *   if (attempt <= 2) {
  *     yield* Console.log(`Attempt ${attempt} failed`)
- *     yield* Effect.fail(`Error ${attempt}`)
+ *     return yield* Effect.fail(`Error ${attempt}`)
  *   }
  *   yield* Console.log(`Attempt ${attempt} succeeded`)
  *   return "success"
@@ -13882,7 +13911,7 @@ export const repeatOrElse: {
    *   attempt++
    *   if (attempt <= 2) {
    *     yield* Console.log(`Attempt ${attempt} failed`)
-   *     yield* Effect.fail(`Error ${attempt}`)
+   *     return yield* Effect.fail(`Error ${attempt}`)
    *   }
    *   yield* Console.log(`Attempt ${attempt} succeeded`)
    *   return "success"
@@ -13935,7 +13964,7 @@ export const repeatOrElse: {
    *   attempt++
    *   if (attempt <= 2) {
    *     yield* Console.log(`Attempt ${attempt} failed`)
-   *     yield* Effect.fail(`Error ${attempt}`)
+   *     return yield* Effect.fail(`Error ${attempt}`)
    *   }
    *   yield* Console.log(`Attempt ${attempt} succeeded`)
    *   return "success"

package/src/ErrorReporter.ts

@@ -39,7 +39,7 @@
  *
  * // Opt in to error reporting with Effect.withErrorReporting
  * const program = Effect.gen(function*() {
- *   yield* new RateLimitError({ retryAfter: 60 })
+ *   return yield* new RateLimitError({ retryAfter: 60 })
  * }).pipe(
  *   Effect.withErrorReporting,
  *   Effect.provide(ErrorReporter.layer([consoleReporter]))
@@ -200,9 +200,7 @@ export const CurrentErrorReporters: ServiceMap.Reference<ReadonlySet<ErrorReport
  *   { mergeWithExisting: true }
  * )
  *
- * const program = Effect.gen(function*() {
- *   yield* Effect.fail("boom")
- * }).pipe(
+ * const program = Effect.fail("boom").pipe(
  *   Effect.withErrorReporting,
  *   Effect.provide(ReporterLive)
  * )