effect 4.0.0-beta.26 → 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
@@ -6656,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"
  * })
@@ -7433,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(
@@ -7464,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(
@@ -7499,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(
@@ -10440,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.
@@ -10506,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*() {
@@ -10540,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*() {
@@ -10585,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*() {
@@ -10626,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*() {
@@ -10660,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*() {
@@ -10704,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*() {
@@ -10744,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*() {
@@ -13024,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)
@@ -13852,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"
@@ -13902,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"
@@ -13955,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)
  * )