effect 4.0.0-beta.69 → 4.0.0-beta.70

package/dist/Layer.js

@@ -27,7 +27,7 @@ const memoMapReuse = (entry, scope) => {
  *   readonly query: (sql: string) => Effect.Effect<string>
  * }>()("Database") {}
  *
- * const dbLayer = Layer.succeed(Database)({
+ * const dbLayer = Layer.succeed(Database, {
  *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed("result"))
  * })
  * const notALayer = { someProperty: "value" }
@@ -56,7 +56,10 @@ const fromBuildUnsafe = build => {
   return self;
 };
 /**
- * Constructs a Layer from a function that uses a `MemoMap` and `Scope` to build the layer.
+ * Constructs a `Layer` from a function that uses a `MemoMap` and `Scope` to
+ * build the layer.
+ *
+ * **Details**
  *
  * The function receives a `MemoMap` for memoization and a `Scope` for resource management.
  * A child scope is created, and if the build fails, the child scope is closed.
@@ -87,8 +90,10 @@ export const fromBuild = build => fromBuildUnsafe((memoMap, scope) => {
   return internalEffect.onExit(build(memoMap, layerScope), exit => exit._tag === "Failure" ? Scope.close(layerScope, exit) : internalEffect.void);
 });
 /**
- * Constructs a Layer from a function that uses a `MemoMap` and `Scope` to build the layer,
- * with automatic memoization.
+ * Constructs a `Layer` from a function that uses a `MemoMap` and `Scope` to
+ * build the layer, with automatic memoization.
+ *
+ * **Details**
  *
  * This is similar to `fromBuild` but provides automatic memoization of the layer construction.
  * The layer will be memoized based on the provided `MemoMap`.
@@ -180,7 +185,7 @@ class MemoMapImpl {
  *   const memoMap = Layer.makeMemoMapUnsafe()
  *   const scope = yield* Effect.scope
  *
- *   const dbLayer = Layer.succeed(Database)({
+ *   const dbLayer = Layer.succeed(Database, {
  *     query: Effect.fn("Database.query")((sql: string) => Effect.succeed("result"))
  *   })
  *   const context = yield* Layer.buildWithMemoMap(dbLayer, memoMap, scope)
@@ -218,7 +223,7 @@ export const forkMemoMapUnsafe = parent => new MemoMapImpl(parent);
  *   const memoMap = yield* Layer.makeMemoMap
  *   const scope = yield* Effect.scope
  *
- *   const dbLayer = Layer.succeed(Database)({
+ *   const dbLayer = Layer.succeed(Database, {
  *     query: Effect.fn("Database.query")((sql: string) => Effect.succeed("result"))
  *   })
  *   const context = yield* Layer.buildWithMemoMap(dbLayer, memoMap, scope)
@@ -242,6 +247,8 @@ export const forkMemoMap = parent => internalEffect.sync(() => forkMemoMapUnsafe
 /**
  * A service reference for the current `MemoMap` used in layer construction.
  *
+ * **Details**
+ *
  * This service provides access to the current memoization map during layer building,
  * allowing layers to share memoized results.
  *
@@ -274,13 +281,13 @@ export class CurrentMemoMap extends /*#__PURE__*/Context.Service()("effect/Layer
  *   const scope = yield* Effect.scope
  *
  *   // Build database layer with memoization
- *   const dbLayer = Layer.succeed(Database)({
+ *   const dbLayer = Layer.succeed(Database, {
  *     query: Effect.fn("Database.query")((sql: string) => Effect.succeed("result"))
  *   })
  *   const dbContext = yield* Layer.buildWithMemoMap(dbLayer, memoMap, scope)
  *
  *   // Build logger layer with same memoization (reuses memo if same layer)
- *   const loggerLayer = Layer.succeed(Logger)({
+ *   const loggerLayer = Layer.succeed(Logger, {
  *     log: Effect.fn("Logger.log")((msg: string) => Effect.sync(() => console.log(msg)))
  *   })
  *   const loggerContext = yield* Layer.buildWithMemoMap(
@@ -314,7 +321,7 @@ export const buildWithMemoMap = /*#__PURE__*/dual(3, (self, memoMap, scope) => i
  *
  * // Build a layer to get its services
  * const program = Effect.gen(function*() {
- *   const dbLayer = Layer.succeed(Database)({
+ *   const dbLayer = Layer.succeed(Database, {
  *     query: Effect.fn("Database.query")((sql: string) => Effect.succeed("result"))
  *   })
  *
@@ -352,7 +359,7 @@ export const build = self => core.withFiber(fiber => buildWithMemoMap(self, Curr
  * const program = Effect.gen(function*() {
  *   const scope = yield* Effect.scope
  *
- *   const dbLayer = Layer.effect(Database)(Effect.gen(function*() {
+ *   const dbLayer = Layer.effect(Database, Effect.gen(function*() {
  *     console.log("Initializing database...")
  *     yield* Scope.addFinalizer(
  *       scope,
@@ -375,9 +382,16 @@ export const build = self => core.withFiber(fiber => buildWithMemoMap(self, Curr
  */
 export const buildWithScope = /*#__PURE__*/dual(2, (self, scope) => core.withFiber(fiber => buildWithMemoMap(self, CurrentMemoMap.getOrCreate(fiber.context), scope)));
 /**
- * Constructs a layer from the specified value.
+ * Constructs a layer that provides a single service from an already available
+ * value.
+ *
+ * **When to use**
  *
- * **Example** (Providing services from values)
+ * Use `succeed` when the service implementation is already constructed and does
+ * not need effectful acquisition. Use `sync` when the service should be created
+ * lazily during layer construction.
+ *
+ * **Example** (Creating a layer from a service implementation)
  *
  * ```ts
  * import { Context, Effect, Layer } from "effect"
@@ -386,34 +400,13 @@ export const buildWithScope = /*#__PURE__*/dual(2, (self, scope) => core.withFib
  *   readonly query: (sql: string) => Effect.Effect<string>
  * }>()("Database") {}
  *
- * class Logger extends Context.Service<Logger, {
- *   readonly log: (msg: string) => Effect.Effect<void>
- * }>()("Logger") {}
- *
- * // Create layers from concrete service implementations
- * const databaseLayer = Layer.succeed(Database)({
+ * const DatabaseLive = Layer.succeed(Database, {
  *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed(`Query result: ${sql}`))
  * })
- *
- * const loggerLayer = Layer.succeed(Logger)({
- *   log: Effect.fn("Logger.log")((msg: string) => Effect.sync(() => console.log(`[LOG] ${msg}`)))
- * })
- *
- * // Use the layers in a program
- * const program = Effect.gen(function*() {
- *   const database = yield* Database
- *   const logger = yield* Logger
- *
- *   yield* logger.log("Starting database query")
- *   const result = yield* database.query("SELECT * FROM users")
- *   yield* logger.log(`Query completed: ${result}`)
- *
- *   return result
- * }).pipe(
- *   Effect.provide(Layer.mergeAll(databaseLayer, loggerLayer))
- * )
  * ```
  *
+ * @see {@link sync} for constructing layers from lazy values
+ *
  * @category constructors
  * @since 2.0.0
  */
@@ -424,11 +417,19 @@ export const succeed = function () {
   return succeedContext(Context.make(arguments[0], arguments[1]));
 };
 /**
- * Constructs a layer from the specified value, which must return one or more
- * services.
+ * Constructs a layer that provides all services in an already available
+ * `Context`.
+ *
+ * **When to use**
+ *
+ * Use `succeedContext` when you already have a `Context` or need to provide
+ * multiple services at once. Use `succeed` when you only need to provide one
+ * service value.
+ *
+ * **Details**
  *
- * This is a more general version of `succeed` that allows you to provide multiple
- * services at once through a `Context`.
+ * This is a more general version of `succeed` that allows you to provide
+ * multiple services at once through a `Context`.
  *
  * **Example** (Providing multiple services from a context)
  *
@@ -454,30 +455,50 @@ export const succeed = function () {
  * const layer = Layer.succeedContext(context)
  * ```
  *
+ * @see {@link succeed} for providing a single service from a value
+ *
  * @category constructors
  * @since 2.0.0
  */
 export const succeedContext = context => fromBuildUnsafe(constant(internalEffect.succeed(context)));
 /**
- * A Layer that constructs an empty Context.
+ * An empty layer that provides no services, cannot fail, has no requirements,
+ * and performs no construction or finalization work.
+ *
+ * **When to use**
  *
- * This layer provides no services and can be used as a neutral element
- * in layer composition or as a starting point for building layers.
+ * Use `Layer.empty` as the no-op branch when conditionally composing layers.
+ * If you need to run an effect during layer construction while still providing
+ * no services, use `effectDiscard`.
  *
- * **Example** (Creating an empty layer)
+ * **Example** (Disabling optional lifecycle work)
  *
  * ```ts
- * import { Layer } from "effect"
+ * import { Console, Layer } from "effect"
+ *
+ * declare const flag: boolean
  *
- * const emptyLayer = Layer.empty
+ * const StartupLogLive = flag
+ *   ? Layer.effectDiscard(Console.log("application starting"))
+ *   : Layer.empty
  * ```
  *
+ * @see {@link effectDiscard} for running an effect while providing no services
+ *
  * @category constructors
  * @since 2.0.0
  */
 export const empty = /*#__PURE__*/succeedContext(/*#__PURE__*/Context.empty());
 /**
- * Lazily constructs a layer from the specified value.
+ * Lazily constructs a layer that provides a single service.
+ *
+ * **When to use**
+ *
+ * Use `sync` when the service can be created synchronously but should be
+ * deferred until the layer is built. Use `succeed` when the service value is
+ * already available.
+ *
+ * **Details**
  *
  * This is a lazy version of `succeed` where the service value is computed
  * synchronously only when the layer is built.
@@ -491,11 +512,13 @@ export const empty = /*#__PURE__*/succeedContext(/*#__PURE__*/Context.empty());
  *   readonly query: (sql: string) => Effect.Effect<string>
  * }>()("Database") {}
  *
- * const layer = Layer.sync(Database)(() => ({
+ * const layer = Layer.sync(Database, () => ({
  *   query: (sql: string) => Effect.succeed(`Query: ${sql}`)
  * }))
  * ```
  *
+ * @see {@link succeed} for constructing layers from static values
+ *
  * @category constructors
  * @since 2.0.0
  */
@@ -506,10 +529,17 @@ export const sync = function () {
   return syncContext(() => Context.make(arguments[0], arguments[1]()));
 };
 /**
- * Lazily constructs a layer from the specified value, which must return one or more
- * services.
+ * Lazily constructs a layer that provides all services in a `Context`.
+ *
+ * **When to use**
+ *
+ * Use `syncContext` when multiple services can be created synchronously and
+ * should be deferred until the layer is built. Use `sync` when you only need to
+ * provide one service.
  *
- * This is a lazy version of `succeedContext` where the Context is computed
+ * **Details**
+ *
+ * This is a lazy version of `succeedContext` where the `Context` is computed
  * synchronously only when the layer is built.
  *
  * **Example** (Lazily providing a context)
@@ -528,15 +558,27 @@ export const sync = function () {
  * )
  * ```
  *
+ * @see {@link sync} for lazily providing a single service
+ * @see {@link succeedContext} for providing an already available context
+ *
  * @category constructors
  * @since 2.0.0
  */
 export const syncContext = evaluate => fromBuildMemo(constant(internalEffect.sync(evaluate)));
 /**
- * Constructs a layer from the specified scoped effect.
+ * Constructs a layer from an effect that produces a single service.
+ *
+ * **When to use**
+ *
+ * Use `effect` when constructing the service requires effects, dependencies, or
+ * scoped resource acquisition. Use `effectContext` when the effect produces
+ * multiple services in a `Context`, and `effectDiscard` when construction work
+ * should provide no services.
  *
- * This allows you to create a Layer from an Effect that produces a service.
- * The Effect is executed in the scope of the layer, allowing for proper
+ * **Details**
+ *
+ * This allows you to create a `Layer` from an `Effect` that produces a service.
+ * The `Effect` is executed in the scope of the layer, allowing for proper
  * resource management.
  *
  * **Example** (Creating a layer from an effect)
@@ -548,13 +590,16 @@ export const syncContext = evaluate => fromBuildMemo(constant(internalEffect.syn
  *   readonly query: (sql: string) => Effect.Effect<string>
  * }>()("Database") {}
  *
- * const layer = Layer.effect(Database)(
+ * const layer = Layer.effect(Database,
  *   Effect.sync(() => ({
  *     query: (sql: string) => Effect.succeed(`Query: ${sql}`)
  *   }))
  * )
  * ```
  *
+ * @see {@link effectContext} for effectfully providing multiple services
+ * @see {@link effectDiscard} for running construction work without providing services
+ *
  * @category constructors
  * @since 2.0.0
  */
@@ -566,11 +611,18 @@ export const effect = function () {
 };
 const effectImpl = (service, effect) => effectContext(internalEffect.map(effect, value => Context.make(service, value)));
 /**
- * Constructs a layer from the specified scoped effect, which must return one
- * or more services.
+ * Constructs a layer from an effect that produces all services in a `Context`.
+ *
+ * **When to use**
  *
- * This allows you to create a Layer from an effectful computation that returns
- * multiple services. The Effect is executed in the scope of the layer.
+ * Use `effectContext` when effectful construction needs to provide multiple
+ * services at once. Use `effect` when the effect produces one service value.
+ *
+ * **Details**
+ *
+ * This allows you to create a `Layer` from an effectful computation that
+ * returns multiple services. The `Effect` is executed in the scope of the
+ * layer.
  *
  * **Example** (Creating a layer from an effectful context)
  *
@@ -589,12 +641,17 @@ const effectImpl = (service, effect) => effectContext(internalEffect.map(effect,
  * )
  * ```
  *
+ * @see {@link effect} for effectfully providing a single service
+ *
  * @category constructors
  * @since 2.0.0
  */
 export const effectContext = effect => fromBuildMemo((_, scope) => Scope.provide(effect, scope));
 /**
- * Constructs a layer from the specified scoped effect.
+ * Constructs a layer from an effect, discarding its value and providing no
+ * services.
+ *
+ * **When to use**
  *
  * This is useful when you want to run an Effect for its side effects during
  * layer construction, but don't need to provide any services.
@@ -611,6 +668,8 @@ export const effectContext = effect => fromBuildMemo((_, scope) => Scope.provide
  * )
  * ```
  *
+ * @see {@link empty} for a no-op layer that performs no construction work
+ *
  * @category constructors
  * @since 2.0.0
  */
@@ -618,6 +677,8 @@ export const effectDiscard = effect => effectContext(internalEffect.as(effect, C
 /**
  * Lazily constructs a layer using the specified factory.
  *
+ * **Details**
+ *
  * The factory is evaluated only when the suspended layer is first built, and
  * the result is memoized with normal layer sharing semantics.
  *
@@ -632,8 +693,8 @@ export const effectDiscard = effect => effectContext(internalEffect.as(effect, C
  *
  * const layer = Layer.suspend(() =>
  *   useProd
- *     ? Layer.succeed(Config)("https://api.example.com")
- *     : Layer.succeed(Config)("http://localhost:3000")
+ *     ? Layer.succeed(Config, "https://api.example.com")
+ *     : Layer.succeed(Config, "http://localhost:3000")
  * )
  * ```
  *
@@ -642,11 +703,17 @@ export const effectDiscard = effect => effectContext(internalEffect.as(effect, C
  */
 export const suspend = evaluate => fromBuildMemo((memoMap, scope) => internalEffect.suspend(() => evaluate().build(memoMap, scope)));
 /**
- * Unwraps a Layer from an Effect, flattening the nested structure.
+ * Unwraps a `Layer` from an `Effect`, flattening the nested structure.
  *
- * This is useful when you have an Effect that produces a Layer, and you want to
- * use that Layer directly. The resulting Layer will have the combined error and
- * dependency types from both the outer Effect and the inner Layer.
+ * **When to use**
+ *
+ * Use this when you have an `Effect` that produces a `Layer` and you want to
+ * use that layer directly.
+ *
+ * **Details**
+ *
+ * The resulting Layer will have the combined error and dependency types from
+ * both the outer Effect and the inner Layer.
  *
  * **Example** (Unwrapping an effectful layer)
  *
@@ -658,7 +725,7 @@ export const suspend = evaluate => fromBuildMemo((memoMap, scope) => internalEff
  * }>()("Database") {}
  *
  * const layerEffect = Effect.succeed(
- *   Layer.succeed(Database)({ query: Effect.fn("Database.query")((sql: string) => Effect.succeed("result")) })
+ *   Layer.succeed(Database, { query: Effect.fn("Database.query")((sql: string) => Effect.succeed("result")) })
  * )
  *
  * const unwrappedLayer = Layer.unwrap(layerEffect)
@@ -678,10 +745,20 @@ const mergeAllEffect = (layers, memoMap, scope) => {
   }).pipe(internalEffect.map(context => Context.mergeAll(...context)));
 };
 /**
- * Combines all the provided layers concurrently, creating a new layer with merged input, error, and output types.
+ * Combines all the provided layers concurrently, creating a new layer with
+ * merged input, error, and output types.
+ *
+ * **When to use**
+ *
+ * Use this when you need to combine multiple independent layers.
+ *
+ * **Details**
  *
  * All layers are built concurrently, and their outputs are merged into a single layer.
- * This is useful when you need to combine multiple independent layers.
+ *
+ * If multiple merged layers depend on the same layer value, that dependency is
+ * shared by default. Reuse a named layer value when you want services to share
+ * the same resource, such as one database pool.
  *
  * **Example** (Merging independent layers)
  *
@@ -696,25 +773,36 @@ const mergeAllEffect = (layers, memoMap, scope) => {
  *   readonly log: (msg: string) => Effect.Effect<void>
  * }>()("Logger") {}
  *
- * const dbLayer = Layer.succeed(Database)({
+ * const dbLayer = Layer.succeed(Database, {
  *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed("result"))
  * })
- * const loggerLayer = Layer.succeed(Logger)({
+ * const loggerLayer = Layer.succeed(Logger, {
  *   log: Effect.fn("Logger.log")((msg: string) => Effect.sync(() => console.log(msg)))
  * })
  *
  * const mergedLayer = Layer.mergeAll(dbLayer, loggerLayer)
  * ```
  *
+ * @see {@link merge} for merging one layer with another layer or array
+ *
  * @category zipping
  * @since 2.0.0
  */
 export const mergeAll = (...layers) => fromBuild((memoMap, scope) => mergeAllEffect(layers, memoMap, scope));
 /**
- * Merges this layer with the specified layer concurrently, producing a new layer with combined input and output types.
+ * Merges this layer with another layer concurrently, producing a new layer with
+ * combined input, error, and output types.
  *
- * This is a binary version of `mergeAll` that merges exactly two layers or one layer with an array of layers.
- * The layers are built concurrently and their outputs are combined.
+ * **When to use**
+ *
+ * Use `merge` when composing from an existing layer in a pipeline. Use
+ * `mergeAll` when you already have all layers as separate arguments.
+ *
+ * **Details**
+ *
+ * This is a binary version of `mergeAll` that merges exactly two layers or one
+ * layer with an array of layers. The layers are built concurrently and their
+ * outputs are combined.
  *
  * **Example** (Merging two layers)
  *
@@ -729,25 +817,37 @@ export const mergeAll = (...layers) => fromBuild((memoMap, scope) => mergeAllEff
  *   readonly log: (msg: string) => Effect.Effect<void>
  * }>()("Logger") {}
  *
- * const dbLayer = Layer.succeed(Database)({
+ * const dbLayer = Layer.succeed(Database, {
  *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed("result"))
  * })
- * const loggerLayer = Layer.succeed(Logger)({
+ * const loggerLayer = Layer.succeed(Logger, {
  *   log: Effect.fn("Logger.log")((msg: string) => Effect.sync(() => console.log(msg)))
  * })
  *
  * const mergedLayer = Layer.merge(dbLayer, loggerLayer)
  * ```
  *
+ * @see {@link mergeAll} for merging several layers at once
+ *
  * @category zipping
  * @since 2.0.0
  */
 export const merge = /*#__PURE__*/dual(2, (self, that) => mergeAll(self, ...(Array.isArray(that) ? that : [that])));
 const provideWith = (self, that, f) => fromBuild((memoMap, scope) => internalEffect.flatMap(Array.isArray(that) ? mergeAllEffect(that, memoMap, scope) : that.build(memoMap, scope), context => self.build(memoMap, scope).pipe(internalEffect.provideContext(context), internalEffect.map(merged => f(merged, context)))));
 /**
- * Feeds the output services of this builder into the input of the specified
- * builder, resulting in a new builder with the inputs of this builder as
- * well as any leftover inputs, and the outputs of the specified builder.
+ * Feeds the output services of the dependency layer into the requirements of
+ * this layer, returning a layer that only provides the services from this layer.
+ *
+ * **When to use**
+ *
+ * Use `provide` when the dependency layer is an implementation detail of the
+ * layer being built and should not be exposed to callers. Use `provideMerge`
+ * when callers should also receive the dependency services.
+ *
+ * **Details**
+ *
+ * In `serviceLayer.pipe(Layer.provide(dependencyLayer))`, the dependency layer is
+ * built first and is used to satisfy the requirements of `serviceLayer`.
  *
  * **Example** (Providing layer dependencies)
  *
@@ -770,16 +870,16 @@ const provideWith = (self, that, f) => fromBuild((memoMap, scope) => internalEff
  * }>()("Logger") {}
  *
  * // Create dependency layers
- * const databaseLayer = Layer.succeed(Database)({
+ * const databaseLayer = Layer.succeed(Database, {
  *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed(`DB: ${sql}`))
  * })
  *
- * const loggerLayer = Layer.succeed(Logger)({
+ * const loggerLayer = Layer.succeed(Logger, {
  *   log: Effect.fn("Logger.log")((msg: string) => Effect.sync(() => console.log(`[LOG] ${msg}`)))
  * })
  *
  * // UserService depends on Database and Logger
- * const userServiceLayer = Layer.effect(UserService)(Effect.gen(function*() {
+ * const userServiceLayer = Layer.effect(UserService, Effect.gen(function*() {
  *   const database = yield* Database
  *   const logger = yield* Logger
  *
@@ -808,14 +908,22 @@ const provideWith = (self, that, f) => fromBuild((memoMap, scope) => internalEff
  * )
  * ```
  *
+ * @see {@link provideMerge} for retaining the dependency services
+ *
  * @category utils
  * @since 2.0.0
  */
 export const provide = /*#__PURE__*/dual(2, (self, that) => provideWith(self, that, identity));
 /**
- * Feeds the output services of this layer into the input of the specified
- * layer, resulting in a new layer with the inputs of this layer, and the
- * outputs of both layers.
+ * Feeds the output services of the dependency layer into the requirements of
+ * this layer, returning a layer that provides both sets of services.
+ *
+ * **When to use**
+ *
+ * Use this when callers need access to both the service being built and the
+ * dependency used to build it, such as a health check that needs both a
+ * repository and its database. Prefer `provide` when the dependency should stay
+ * private.
  *
  * **Example** (Providing dependencies while retaining services)
  *
@@ -838,16 +946,16 @@ export const provide = /*#__PURE__*/dual(2, (self, that) => provideWith(self, th
  * }>()("UserService") {}
  *
  * // Create dependency layers
- * const databaseLayer = Layer.succeed(Database)({
+ * const databaseLayer = Layer.succeed(Database, {
  *   query: Effect.fn("Database.query")((sql: string) => Effect.succeed(`DB: ${sql}`))
  * })
  *
- * const loggerLayer = Layer.succeed(Logger)({
+ * const loggerLayer = Layer.succeed(Logger, {
  *   log: Effect.fn("Logger.log")((msg: string) => Effect.sync(() => console.log(`[LOG] ${msg}`)))
  * })
  *
  * // UserService depends on Database and Logger
- * const userServiceLayer = Layer.effect(UserService)(Effect.gen(function*() {
+ * const userServiceLayer = Layer.effect(UserService, Effect.gen(function*() {
  *   const database = yield* Database
  *   const logger = yield* Logger
  *
@@ -882,6 +990,8 @@ export const provide = /*#__PURE__*/dual(2, (self, that) => provideWith(self, th
  * )
  * ```
  *
+ * @see {@link provide} for keeping dependency services private
+ *
  * @category utils
  * @since 2.0.0
  */
@@ -908,7 +1018,7 @@ export const provideMerge = /*#__PURE__*/dual(2, (self, that) => provideWith(sel
  * }>()("Logger") {}
  *
  * // Base config layer
- * const configLayer = Layer.succeed(Config)({
+ * const configLayer = Layer.succeed(Config, {
  *   dbUrl: "postgres://localhost:5432/mydb",
  *   logLevel: "debug"
  * })
@@ -919,7 +1029,7 @@ export const provideMerge = /*#__PURE__*/dual(2, (self, that) => provideWith(sel
  *     const config = Context.get(context, Config)
  *
  *     // Create database layer based on config
- *     const dbLayer = Layer.succeed(Database)({
+ *     const dbLayer = Layer.succeed(Database, {
  *       query: Effect.fn("Database.query")((sql: string) =>
  *         Effect.succeed(
  *           `Querying ${config.dbUrl}: ${sql}`
@@ -927,7 +1037,7 @@ export const provideMerge = /*#__PURE__*/dual(2, (self, that) => provideWith(sel
  *     })
  *
  *     // Create logger layer based on config
- *     const loggerLayer = Layer.succeed(Logger)({
+ *     const loggerLayer = Layer.succeed(Logger, {
  *       log: Effect.fn("Logger.log")((msg: string) =>
  *         config.logLevel === "debug"
  *           ? Effect.sync(() => console.log(`[DEBUG] ${msg}`))
@@ -961,6 +1071,11 @@ export const flatMap = /*#__PURE__*/dual(2, (self, f) => fromBuild((memoMap, sco
 /**
  * Performs the specified effect if this layer succeeds.
  *
+ * **Details**
+ *
+ * The callback receives the services produced by this layer. Its result is
+ * discarded, and the original layer output is preserved.
+ *
  * @category sequencing
  * @since 2.0.0
  */
@@ -968,6 +1083,12 @@ export const tap = /*#__PURE__*/dual(2, (self, f) => fromBuild((memoMap, scope)
 /**
  * Performs the specified effect if this layer fails.
  *
+ * **Details**
+ *
+ * The callback receives the typed error. If the callback succeeds, the layer
+ * still fails with the original error; if the callback fails, that failure is
+ * added to the layer's error type.
+ *
  * @category sequencing
  * @since 2.0.0
  */
@@ -976,6 +1097,7 @@ export const tapError = /*#__PURE__*/dual(2, (self, f) => fromBuild((memoMap, sc
  * Performs the specified effect when this layer fails with any cause.
  *
  * **Details**
+ *
  * The callback receives the layer's `Cause`, so it can inspect typed errors,
  * defects, and interruption information. If the callback succeeds, the layer
  * fails again with the original cause; if the callback fails, that failure is
@@ -986,8 +1108,13 @@ export const tapError = /*#__PURE__*/dual(2, (self, f) => fromBuild((memoMap, sc
  */
 export const tapCause = /*#__PURE__*/dual(2, (self, f) => fromBuild((memoMap, scope) => internalEffect.catchCause(self.build(memoMap, scope), cause => Scope.provide(internalEffect.andThen(f(cause), internalEffect.failCause(cause)), scope))));
 /**
- * Translates effect failure into death of the fiber, making all failures
- * unchecked and not a part of the type of the layer.
+ * Converts layer construction failures into defects, removing them from the
+ * layer's error type.
+ *
+ * **Details**
+ *
+ * Use this only when failures should be treated as unrecoverable defects rather
+ * than typed errors that callers can handle.
  *
  * **Example** (Converting layer failures to defects)
  *
@@ -1003,7 +1130,7 @@ export const tapCause = /*#__PURE__*/dual(2, (self, f) => fromBuild((memoMap, sc
  * }>()("Database") {}
  *
  * // Layer that can fail during construction
- * const flakyDatabaseLayer = Layer.effect(Database)(Effect.gen(function*() {
+ * const flakyDatabaseLayer = Layer.effect(Database, Effect.gen(function*() {
  *   console.log("connecting")
  *   return yield* new DatabaseError({ message: "Connection failed" })
  * }))
@@ -1030,7 +1157,16 @@ export const orDie = self => fromBuildUnsafe((memoMap, scope) => internalEffect.
 const catch_ = /*#__PURE__*/dual(2, (self, onError) => fromBuildUnsafe((memoMap, scope) => internalEffect.catch_(self.build(memoMap, scope), e => onError(e).build(memoMap, scope))));
 export {
 /**
- * Recovers from all errors.
+ * Recovers from all typed errors by switching to another layer.
+ *
+ * **When to use**
+ *
+ * Use `catch` when every typed construction error should use the same recovery
+ * path. Use `catchTag` to recover from specific tagged errors, and `catchCause`
+ * when recovery needs the full failure cause.
+ *
+ * @see {@link catchTag} for recovering from specific tagged errors
+ * @see {@link catchCause} for recovering with access to the full cause
  *
  * @category error handling
  * @since 4.0.0
@@ -1039,6 +1175,12 @@ catch_ as catch };
 /**
  * Recovers from specific tagged errors.
  *
+ * **When to use**
+ *
+ * Use `catchTag` when only some tagged construction errors should be recovered.
+ * Use `catchCause` when recovery depends on defects, interruption, or other
+ * cause information.
+ *
  * **Example** (Recovering from tagged layer errors)
  *
  * ```ts
@@ -1050,15 +1192,17 @@ catch_ as catch };
  *   readonly apiUrl: string
  * }>()("Config") {}
  *
- * const configLayer = Layer.effect(Config)(Effect.fail(new ConfigError()))
+ * const configLayer = Layer.effect(Config, Effect.fail(new ConfigError()))
  *
- * const fallbackLayer = Layer.succeed(Config)({ apiUrl: "http://localhost" })
+ * const fallbackLayer = Layer.succeed(Config, { apiUrl: "http://localhost" })
  *
  * const recovered = configLayer.pipe(
  *   Layer.catchTag("ConfigError", () => fallbackLayer)
  * )
  * ```
  *
+ * @see {@link catchCause} for recovering with access to the full cause
+ *
  * @category error handling
  * @since 4.0.0
  */
@@ -1066,10 +1210,18 @@ export const catchTag = /*#__PURE__*/dual(3, (self, k, f) => fromBuildUnsafe((me
 /**
  * Recovers from any failure cause by switching to another layer.
  *
+ * **When to use**
+ *
+ * Use `catchCause` when recovery needs more than the typed error, such as
+ * defects or interruption information. Use `catchTag` when recovery only needs
+ * to match specific tagged errors.
+ *
  * **Details**
+ *
  * The handler receives the full `Cause` of the failed layer, including typed
- * errors, defects, and interruption information, and returns the fallback layer
- * to build instead.
+ * errors, unexpected defects, and interruption information, and returns the
+ * fallback layer to build instead. Finalizers for resources acquired by the
+ * failed layer are still run before the fallback layer is acquired.
  *
  * **Example** (Recovering from layer failures by cause)
  *
@@ -1084,13 +1236,13 @@ export const catchTag = /*#__PURE__*/dual(3, (self, k, f) => fromBuildUnsafe((me
  *   readonly query: (sql: string) => Effect.Effect<string>
  * }>()("Database") {}
  *
- * const primaryDatabaseLayer = Layer.effect(Database)(
+ * const primaryDatabaseLayer = Layer.effect(Database,
  *   Effect.fail(new DatabaseError({ message: "Primary DB unreachable" }))
  * )
  *
  * const databaseWithFallback = primaryDatabaseLayer.pipe(
  *   Layer.catchCause(() => {
- *     return Layer.succeed(Database)({
+ *     return Layer.succeed(Database, {
  *       query: Effect.fn("Database.query")((sql: string) => Effect.succeed(`Memory: ${sql}`))
  *     })
  *   })
@@ -1108,6 +1260,8 @@ export const catchTag = /*#__PURE__*/dual(3, (self, k, f) => fromBuildUnsafe((me
  * // Memory: SELECT * FROM users
  * ```
  *
+ * @see {@link catchTag} for recovering from specific tagged errors
+ *
  * @category error handling
  * @since 4.0.0
  */
@@ -1115,6 +1269,11 @@ export const catchCause = /*#__PURE__*/dual(2, (self, onError) => fromBuildUnsaf
 /**
  * Updates a service in the context with a new implementation.
  *
+ * **When to use**
+ *
+ * Use this to adapt or extend a service's behavior during the creation of a
+ * layer.
+ *
  * **Details**
  *
  * This function modifies the existing implementation of a service in the
@@ -1122,11 +1281,6 @@ export const catchCause = /*#__PURE__*/dual(2, (self, onError) => fromBuildUnsaf
  * transformation function `f`, and replaces the old service with the
  * transformed one.
  *
- * **When to Use**
- *
- * This is useful for adapting or extending a service's behavior during the
- * creation of a layer.
- *
  * @category utils
  * @since 3.13.0
  */
@@ -1134,6 +1288,13 @@ export const updateService = /*#__PURE__*/dual(3, (layer, service, f) => provide
 /**
  * Creates a fresh version of this layer that will not be shared.
  *
+ * **When to use**
+ *
+ * Use `fresh` when two parts of an application must receive separate instances
+ * of a resource, such as two independent client sessions. Do not use it just to
+ * work around confusing composition: by default, sharing the same layer value is
+ * usually the desired behavior.
+ *
  * **Example** (Creating non-shared layer instances)
  *
  * ```ts
@@ -1151,12 +1312,12 @@ export const updateService = /*#__PURE__*/dual(3, (layer, service, f) => provide
  *   readonly counterId: number
  * }>()("Right") {}
  *
- * const leftLayer = Layer.effect(Left)(Effect.gen(function*() {
+ * const leftLayer = Layer.effect(Left, Effect.gen(function*() {
  *   const counter = yield* Counter
  *   return { counterId: counter.id }
  * }))
  *
- * const rightLayer = Layer.effect(Right)(Effect.gen(function*() {
+ * const rightLayer = Layer.effect(Right, Effect.gen(function*() {
  *   const counter = yield* Counter
  *   return { counterId: counter.id }
  * }))
@@ -1170,7 +1331,7 @@ export const updateService = /*#__PURE__*/dual(3, (layer, service, f) => provide
  * const program = Effect.gen(function*() {
  *   const nextId = yield* Ref.make(0)
  *
- *   const counterLayer = Layer.effect(Counter)(Effect.gen(function*() {
+ *   const counterLayer = Layer.effect(Counter, Effect.gen(function*() {
  *     const id = yield* Ref.updateAndGet(nextId, (n) => n + 1)
  *     console.log("constructed Counter")
  *     return { id }
@@ -1205,8 +1366,16 @@ export const updateService = /*#__PURE__*/dual(3, (layer, service, f) => provide
  */
 export const fresh = self => fromBuildUnsafe((_, scope) => self.build(makeMemoMapUnsafe(), scope));
 /**
- * Builds this layer and uses it until it is interrupted. This is useful when
- * your entire application is a layer, such as an HTTP server.
+ * Builds this layer and keeps it alive until the returned effect is interrupted.
+ *
+ * **When to use**
+ *
+ * Use this when your entire application is a layer, such as an HTTP server.
+ *
+ * **Details**
+ *
+ * When the returned effect is interrupted, the layer scope is closed and all
+ * finalizers registered during layer acquisition are run.
  *
  * **Example** (Launching an application layer)
  *
@@ -1223,7 +1392,7 @@ export const fresh = self => fromBuildUnsafe((_, scope) => self.build(makeMemoMa
  * }>()("Logger") {}
  *
  * // Server layer that starts an HTTP server
- * const serverLayer = Layer.effect(HttpServer)(Effect.gen(function*() {
+ * const serverLayer = Layer.effect(HttpServer, Effect.gen(function*() {
  *   yield* Console.log("Starting HTTP server...")
  *
  *   return {
@@ -1238,7 +1407,7 @@ export const fresh = self => fromBuildUnsafe((_, scope) => self.build(makeMemoMa
  *   }
  * }))
  *
- * const loggerLayer = Layer.succeed(Logger)({
+ * const loggerLayer = Layer.succeed(Logger, {
  *   log: Effect.fn("Logger.log")((msg: string) => Console.log(`[LOG] ${msg}`))
  * })
  *
@@ -1262,8 +1431,16 @@ export const fresh = self => fromBuildUnsafe((_, scope) => self.build(makeMemoMa
 export const launch = self => internalEffect.scoped(internalEffect.andThen(build(self), internalEffect.never));
 /**
  * Creates a mock layer for testing purposes. You can provide a partial
- * implementation of the service, and any methods not provided will
- * throw an unimplemented defect when called.
+ * implementation of the service. Any missing members that are `Effect`s,
+ * `Stream`s, `Channel`s, or functions returning them will fail with an
+ * unimplemented defect when used.
+ *
+ * **Details**
+ *
+ * Missing members are represented by a value that can be used as an `Effect`,
+ * `Stream`, `Channel`, or as a function returning an `Effect`. This lets the
+ * mock preserve the shape of common service methods while still failing loudly
+ * when an unimplemented member is exercised.
  *
  * **Example** (Mocking services for tests)
  *
@@ -1304,7 +1481,7 @@ export const launch = self => internalEffect.scoped(internalEffect.andThen(build
  * )
  * ```
  *
- * @category Testing
+ * @category testing
  * @since 3.17.0
  */
 export const mock = function () {
@@ -1356,10 +1533,12 @@ const ChannelTypeId = "~effect/Channel";
 // Type constraints
 // -----------------------------------------------------------------------------
 /**
- * Ensures that an layer's success type extends a given type `ROut`.
+ * Ensures that a layer's success type extends a given type `ROut`.
+ *
+ * **Details**
  *
  * This function provides compile-time type checking to ensure that the success
- * value of an layer conforms to a specific type constraint.
+ * value of a layer conforms to a specific type constraint.
  *
  * **Example** (Constraining layer success types)
  *
@@ -1381,15 +1560,17 @@ const ChannelTypeId = "~effect/Channel";
  * // Type 'string' is not assignable to type 'number'
  * ```
  *
- * @category Type constraints
+ * @category utility types
  * @since 4.0.0
  */
 export const satisfiesSuccessType = () => layer => layer;
 /**
- * Ensures that an layer's error type extends a given type `E`.
+ * Ensures that a layer's error type extends a given type `E`.
+ *
+ * **Details**
  *
  * This function provides compile-time type checking to ensure that the error
- * type of an layer conforms to a specific type constraint.
+ * type of a layer conforms to a specific type constraint.
  *
  * **Example** (Constraining layer error types)
  *
@@ -1412,15 +1593,17 @@ export const satisfiesSuccessType = () => layer => layer;
  * // Type 'string' is not assignable to type 'Error'
  * ```
  *
- * @category Type constraints
+ * @category utility types
  * @since 4.0.0
  */
 export const satisfiesErrorType = () => layer => layer;
 /**
- * Ensures that an layer's requirements type extends a given type `R`.
+ * Ensures that a layer's requirements type extends a given type `R`.
+ *
+ * **Details**
  *
  * This function provides compile-time type checking to ensure that the
- * requirements (context) type of an layer conforms to a specific type constraint.
+ * requirements type of a layer conforms to a specific type constraint.
  *
  * **Example** (Constraining layer service requirements)
  *
@@ -1442,7 +1625,7 @@ export const satisfiesErrorType = () => layer => layer;
  * // Type 'string' is not assignable to type 'number'
  * ```
  *
- * @category Type constraints
+ * @category utility types
  * @since 4.0.0
  */
 export const satisfiesServicesType = () => layer => layer;
@@ -1450,9 +1633,13 @@ export const satisfiesServicesType = () => layer => layer;
  * Constructs a new `Layer` which creates a span and registers it as the current
  * parent span.
  *
+ * **Details**
+ *
  * This allows you to create a traced scope for layer construction, making all
  * operations within the layer constructor part of the same trace span. The span
- * is automatically closed when the layer's scope is closed.
+ * is automatically ended when the layer's scope is closed. If `onEnd` is
+ * provided, it receives the span and the layer scope's exit value when the span
+ * ends.
  *
  * **Example** (Tracing layer construction with a span)
  *
@@ -1501,6 +1688,7 @@ export const span = (name, options) => {
  * Constructs a layer that provides an existing span as the current parent span.
  *
  * **Details**
+ *
  * The supplied span is made available through `Tracer.ParentSpan` for layers
  * that are built with this layer. This API does not create, end, or close the
  * span; the caller remains responsible for the span's lifetime.
@@ -1538,9 +1726,11 @@ export const span = (name, options) => {
  */
 export const parentSpan = span => succeedContext(Tracer.ParentSpan.context(span));
 /**
- * Wraps a Layer with a new tracing span, making all operations in the layer
+ * Wraps a `Layer` with a new tracing span, making all operations in the layer
  * constructor part of the named trace span.
  *
+ * **Details**
+ *
  * This creates a new span for the layer's construction and execution. The span
  * is automatically ended when the layer's scope is closed. This is useful for
  * tracking the lifecycle and performance of layer initialization.
@@ -1589,8 +1779,7 @@ export const parentSpan = span => succeedContext(Tracer.ParentSpan.context(span)
  *
  *   yield* logger.log("Application ready")
  *   return yield* database.query("SELECT * FROM users")
- * }).pipe(Effect.provide(appLayer)
- * )
+ * }).pipe(Effect.provide(appLayer))
  * ```
  *
  * @category tracing
@@ -1611,9 +1800,15 @@ export const withSpan = function () {
  * as their parent.
  *
  * **Details**
+ *
  * Use this to attach layer construction to an existing trace hierarchy. This API
  * does not create or end the supplied parent span.
  *
+ * When the supplied span is a native `Span`, layer construction also receives
+ * diagnostic information that helps associate failures with the layer call site.
+ * External spans are only installed as the parent span and do not add this
+ * diagnostic call-site information.
+ *
  * **Example** (Attaching layers to an existing parent span)
  *
  * ```ts