effect 4.0.0-beta.66 → 4.0.0-beta.68

package/src/Context.ts

@@ -24,22 +24,35 @@ import { hasProperty } from "./Predicate.ts"
 import type * as Types from "./Types.ts"
 
 /**
- * @since 4.0.0
+ * String literal type used as the runtime type identifier for `Context`
+ * service keys.
+ *
  * @category Type Identifiers
+ * @since 4.0.0
  */
 export type ServiceTypeId = "~effect/Context/Service"
 
 /**
- * @since 4.0.0
+ * Runtime type identifier attached to `Context` service keys and used by
+ * `isKey` to recognize them.
+ *
  * @category Type Identifiers
+ * @since 4.0.0
  */
 export const ServiceTypeId: ServiceTypeId = "~effect/Context/Service"
 
 /**
- * The base type used for all Context keys.
+ * Typed identifier for a service stored in a `Context`.
  *
+ * **Details**
+ *
+ * `Identifier` tracks the requirement in Effect types, while `Shape` is the
+ * service implementation retrieved by the key. A key is also an Effect value,
+ * so yielding it inside `Effect.gen` retrieves the service from the current
+ * fiber context.
+ *
+ * @category models
  * @since 4.0.0
- * @category Models
  */
 export interface Key<out Identifier, out Shape> extends Effect<Shape, never, Identifier> {
   readonly [ServiceTypeId]: ServiceTypeId
@@ -50,7 +63,16 @@ export interface Key<out Identifier, out Shape> extends Effect<Shape, never, Ide
 }
 
 /**
- * @example
+ * Context key with helper methods for working with a service.
+ *
+ * **Details**
+ *
+ * `context` creates a one-service `Context`, `use` and `useSync` retrieve the
+ * service from the current Effect context before applying a function, and `of`
+ * is a type-level helper for service values.
+ *
+ * **Example** (Defining a service key)
+ *
  * ```ts
  * import { Context } from "effect"
  *
@@ -63,8 +85,8 @@ export interface Key<out Identifier, out Shape> extends Effect<Shape, never, Ide
  * const context = Context.make(Database, { query: (sql) => `Result: ${sql}` })
  * ```
  *
+ * @category models
  * @since 4.0.0
- * @category Models
  */
 export interface Service<in out Identifier, in out Shape> extends Key<Identifier, Shape> {
   of(this: void, self: Shape): Shape
@@ -74,8 +96,15 @@ export interface Service<in out Identifier, in out Shape> extends Key<Identifier
 }
 
 /**
+ * Class-style service key produced by `Context.Service<Self, Shape>()("Id")`.
+ *
+ * **Details**
+ *
+ * Use this shape when declaring services as classes. The class itself is the
+ * Context key, and its string `key` identifies the service at runtime.
+ *
+ * @category models
  * @since 4.0.0
- * @category Models
  */
 export interface ServiceClass<in out Self, in out Identifier extends string, in out Shape>
   extends Service<Self, Shape>
@@ -85,13 +114,18 @@ export interface ServiceClass<in out Self, in out Identifier extends string, in
 }
 
 /**
+ * Namespace containing helper types for class-style `Context.Service`
+ * declarations.
+ *
  * @since 4.0.0
- * @category Models
  */
 export declare namespace ServiceClass {
   /**
+   * Runtime and type-level metadata carried by a class-style service key,
+   * including its service type identifier, string key, and service shape.
+   *
+   * @category models
    * @since 4.0.0
-   * @category Models
    */
   export interface Shape<Identifier extends string, Service> {
     readonly [ServiceTypeId]: typeof ServiceTypeId
@@ -101,7 +135,17 @@ export declare namespace ServiceClass {
 }
 
 /**
- * @example
+ * Creates a `Context` service key.
+ *
+ * **Details**
+ *
+ * Call `Context.Service("Key")` for a function-style key, or use the two-stage
+ * form `Context.Service<Self, Shape>()("Key")` for class-style service
+ * declarations. The returned key can be yielded as an Effect and passed to
+ * `Context.make`, `Context.add`, and the Context getter functions.
+ *
+ * **Example** (Creating service keys)
+ *
  * ```ts
  * import { Context } from "effect"
  *
@@ -122,12 +166,22 @@ export declare namespace ServiceClass {
  * const config = Context.make(Config, { port: 8080 })
  * ```
  *
+ * @category constructors
  * @since 4.0.0
- * @category Constructors
  */
 export const Service: {
   /**
-   * @example
+   * Creates a `Context` service key.
+   *
+   * **Details**
+   *
+   * Call `Context.Service("Key")` for a function-style key, or use the two-stage
+   * form `Context.Service<Self, Shape>()("Key")` for class-style service
+   * declarations. The returned key can be yielded as an Effect and passed to
+   * `Context.make`, `Context.add`, and the Context getter functions.
+   *
+   * **Example** (Creating service keys)
+   *
    * ```ts
    * import { Context } from "effect"
    *
@@ -148,12 +202,22 @@ export const Service: {
    * const config = Context.make(Config, { port: 8080 })
    * ```
    *
+   * @category constructors
    * @since 4.0.0
-   * @category Constructors
    */
   <Identifier, Shape = Identifier>(key: string): Service<Identifier, Shape>
   /**
-   * @example
+   * Creates a `Context` service key.
+   *
+   * **Details**
+   *
+   * Call `Context.Service("Key")` for a function-style key, or use the two-stage
+   * form `Context.Service<Self, Shape>()("Key")` for class-style service
+   * declarations. The returned key can be yielded as an Effect and passed to
+   * `Context.make`, `Context.add`, and the Context getter functions.
+   *
+   * **Example** (Creating service keys)
+   *
    * ```ts
    * import { Context } from "effect"
    *
@@ -174,8 +238,8 @@ export const Service: {
    * const config = Context.make(Config, { port: 8080 })
    * ```
    *
+   * @category constructors
    * @since 4.0.0
-   * @category Constructors
    */
   <Self, Shape>(): <
     const Identifier extends string,
@@ -192,7 +256,17 @@ export const Service: {
     & ([Types.unassigned] extends [R] ? unknown
       : { readonly make: [Args] extends [never] ? Effect<Shape, E, R> : (...args: Args) => Effect<Shape, E, R> })
   /**
-   * @example
+   * Creates a `Context` service key.
+   *
+   * **Details**
+   *
+   * Call `Context.Service("Key")` for a function-style key, or use the two-stage
+   * form `Context.Service<Self, Shape>()("Key")` for class-style service
+   * declarations. The returned key can be yielded as an Effect and passed to
+   * `Context.make`, `Context.add`, and the Context getter functions.
+   *
+   * **Example** (Creating service keys)
+   *
    * ```ts
    * import { Context } from "effect"
    *
@@ -213,8 +287,8 @@ export const Service: {
    * const config = Context.make(Config, { port: 8080 })
    * ```
    *
+   * @category constructors
    * @since 4.0.0
-   * @category Constructors
    */
   <Self>(): <
     const Identifier extends string,
@@ -302,7 +376,16 @@ const ServiceProto: any = {
 const ReferenceTypeId = "~effect/Context/Reference" as const
 
 /**
- * @example
+ * Service key with a lazily computed default value.
+ *
+ * **Details**
+ *
+ * When a `Reference` is requested from a `Context` that does not contain an
+ * override, Context getters that resolve references return the cached default
+ * value instead of failing.
+ *
+ * **Example** (Defining a reference with a default value)
+ *
  * ```ts
  * import { Context } from "effect"
  *
@@ -317,8 +400,8 @@ const ReferenceTypeId = "~effect/Context/Reference" as const
  * const logger = Context.get(context, LoggerRef) // Uses default value
  * ```
  *
- * @since 4.0.0
- * @category Models
+ * @category models
+ * @since 3.11.0
  */
 export interface Reference<in out Shape> extends Service<never, Shape> {
   readonly [ReferenceTypeId]: typeof ReferenceTypeId
@@ -328,7 +411,10 @@ export interface Reference<in out Shape> extends Service<never, Shape> {
 }
 
 /**
- * @example
+ * Namespace containing utility types for `Context` service keys.
+ *
+ * **Example** (Extracting service types)
+ *
  * ```ts
  * import { Context } from "effect"
  *
@@ -343,12 +429,15 @@ export interface Reference<in out Shape> extends Service<never, Shape> {
  * type DatabaseId = Context.Service.Identifier<typeof Database>
  * ```
  *
- * @since 4.0.0
- * @category Models
+ * @since 2.0.0
  */
 export declare namespace Service {
   /**
-   * @example
+   * Type that matches any `Context` service key regardless of its identifier or
+   * service shape.
+   *
+   * **Example** (Typing any service key)
+   *
    * ```ts
    * import { Context } from "effect"
    *
@@ -359,13 +448,17 @@ export declare namespace Service {
    * ]
    * ```
    *
+   * @category models
    * @since 4.0.0
-   * @category Models
    */
   export type Any = Key<never, any> | Key<any, any>
 
   /**
-   * @example
+   * Extracts the service implementation type stored behind a `Context` service
+   * key.
+   *
+   * **Example** (Extracting a service shape)
+   *
    * ```ts
    * import { Context } from "effect"
    *
@@ -378,13 +471,17 @@ export declare namespace Service {
    * // DatabaseService is { query: (sql: string) => string }
    * ```
    *
+   * @category models
    * @since 4.0.0
-   * @category Models
    */
   export type Shape<T> = T extends Key<infer _I, infer S> ? S : never
 
   /**
-   * @example
+   * Extracts the identifier, or requirement type, associated with a `Context`
+   * service key.
+   *
+   * **Example** (Extracting a service identifier)
+   *
    * ```ts
    * import { Context } from "effect"
    *
@@ -397,8 +494,8 @@ export declare namespace Service {
    * // DatabaseId is the identifier type
    * ```
    *
-   * @since 4.0.0
-   * @category Models
+   * @category models
+   * @since 2.0.0
    */
   export type Identifier<T> = T extends Key<infer I, infer _S> ? I : never
 }
@@ -406,7 +503,16 @@ export declare namespace Service {
 const TypeId = "~effect/Context" as const
 
 /**
- * @example
+ * Immutable collection of service implementations used for dependency
+ * injection in Effect programs.
+ *
+ * **Details**
+ *
+ * The type parameter tracks the service identifiers available in the context.
+ * At runtime, services are stored by each key's string `key`.
+ *
+ * **Example** (Creating a context with multiple services)
+ *
  * ```ts
  * import { Context } from "effect"
  *
@@ -422,8 +528,8 @@ const TypeId = "~effect/Context" as const
  *   .pipe(Context.add(Database, { query: (sql) => `Result: ${sql}` }))
  * ```
  *
- * @since 4.0.0
- * @category Models
+ * @category models
+ * @since 2.0.0
  */
 export interface Context<in Services> extends Equal.Equal, Pipeable, Inspectable {
   readonly [TypeId]: {
@@ -434,7 +540,17 @@ export interface Context<in Services> extends Equal.Equal, Pipeable, Inspectable
 }
 
 /**
- * @example
+ * Creates a `Context` from an existing service map without validating or
+ * copying it.
+ *
+ * **Notes**
+ *
+ * This is unsafe because later mutation of the provided map can affect the
+ * created `Context`. Prefer `empty`, `make`, `add`, or `merge` for normal
+ * Context construction.
+ *
+ * **Example** (Creating a context from a map)
+ *
  * ```ts
  * import { Context } from "effect"
  *
@@ -446,8 +562,8 @@ export interface Context<in Services> extends Equal.Equal, Pipeable, Inspectable
  * const context = Context.makeUnsafe(map)
  * ```
  *
+ * @category constructors
  * @since 4.0.0
- * @category Constructors
  */
 export const makeUnsafe = <Services = never>(mapUnsafe: ReadonlyMap<string, any>): Context<Services> => {
   const self = Object.create(Proto)
@@ -490,7 +606,8 @@ const Proto: Omit<Context<never>, "mapUnsafe" | "mutable"> = {
 /**
  * Checks if the provided argument is a `Context`.
  *
- * @example
+ * **Example** (Checking for contexts)
+ *
  * ```ts
  * import { Context } from "effect"
  * import * as assert from "node:assert"
@@ -498,15 +615,16 @@ const Proto: Omit<Context<never>, "mapUnsafe" | "mutable"> = {
  * assert.strictEqual(Context.isContext(Context.empty()), true)
  * ```
  *
- * @since 4.0.0
- * @category Guards
+ * @category guards
+ * @since 2.0.0
  */
 export const isContext = (u: unknown): u is Context<never> => hasProperty(u, TypeId)
 
 /**
  * Checks if the provided argument is a `Key`.
  *
- * @example
+ * **Example** (Checking for keys)
+ *
  * ```ts
  * import { Context } from "effect"
  * import * as assert from "node:assert"
@@ -514,15 +632,16 @@ export const isContext = (u: unknown): u is Context<never> => hasProperty(u, Typ
  * assert.strictEqual(Context.isKey(Context.Service("Service")), true)
  * ```
  *
+ * @category guards
  * @since 4.0.0
- * @category Guards
  */
 export const isKey = (u: unknown): u is Key<any, any> => hasProperty(u, ServiceTypeId)
 
 /**
  * Checks if the provided argument is a `Reference`.
  *
- * @example
+ * **Example** (Checking for references)
+ *
  * ```ts
  * import { Context } from "effect"
  * import * as assert from "node:assert"
@@ -535,15 +654,16 @@ export const isKey = (u: unknown): u is Key<any, any> => hasProperty(u, ServiceT
  * assert.strictEqual(Context.isReference(Context.Service("Key")), false)
  * ```
  *
- * @since 4.0.0
- * @category Guards
+ * @category guards
+ * @since 3.11.0
  */
 export const isReference = (u: unknown): u is Reference<any> => hasProperty(u, ReferenceTypeId)
 
 /**
  * Returns an empty `Context`.
  *
- * @example
+ * **Example** (Creating an empty context)
+ *
  * ```ts
  * import { Context } from "effect"
  * import * as assert from "node:assert"
@@ -551,8 +671,8 @@ export const isReference = (u: unknown): u is Reference<any> => hasProperty(u, R
  * assert.strictEqual(Context.isContext(Context.empty()), true)
  * ```
  *
- * @since 4.0.0
- * @category Constructors
+ * @category constructors
+ * @since 2.0.0
  */
 export const empty = (): Context<never> => emptyContext
 const emptyContext = makeUnsafe(new Map())
@@ -560,7 +680,8 @@ const emptyContext = makeUnsafe(new Map())
 /**
  * Creates a new `Context` with a single service associated to the key.
  *
- * @example
+ * **Example** (Creating a context with one service)
+ *
  * ```ts
  * import { Context } from "effect"
  * import * as assert from "node:assert"
@@ -572,8 +693,8 @@ const emptyContext = makeUnsafe(new Map())
  * assert.deepStrictEqual(Context.get(context, Port), { PORT: 8080 })
  * ```
  *
- * @since 4.0.0
- * @category Constructors
+ * @category constructors
+ * @since 2.0.0
  */
 export const make = <I, S>(
   key: Key<I, S>,
@@ -583,9 +704,10 @@ export const make = <I, S>(
 /**
  * Adds a service to a given `Context`.
  *
- * @example
+ * **Example** (Adding a service to a context)
+ *
  * ```ts
- * import { pipe, Context } from "effect"
+ * import { Context, pipe } from "effect"
  * import * as assert from "node:assert"
  *
  * const Port = Context.Service<{ PORT: number }>("Port")
@@ -602,16 +724,17 @@ export const make = <I, S>(
  * assert.deepStrictEqual(Context.get(context, Timeout), { TIMEOUT: 5000 })
  * ```
  *
- * @since 4.0.0
  * @category Adders
+ * @since 2.0.0
  */
 export const add: {
   /**
    * Adds a service to a given `Context`.
    *
-   * @example
+   * **Example** (Adding a service to a context)
+   *
    * ```ts
-   * import { pipe, Context } from "effect"
+   * import { Context, pipe } from "effect"
    * import * as assert from "node:assert"
    *
    * const Port = Context.Service<{ PORT: number }>("Port")
@@ -628,16 +751,17 @@ export const add: {
    * assert.deepStrictEqual(Context.get(context, Timeout), { TIMEOUT: 5000 })
    * ```
    *
-   * @since 4.0.0
    * @category Adders
+   * @since 2.0.0
    */
   <I, S>(key: Key<I, S>, service: Types.NoInfer<S>): <Services>(self: Context<Services>) => Context<Services | I>
   /**
    * Adds a service to a given `Context`.
    *
-   * @example
+   * **Example** (Adding a service to a context)
+   *
    * ```ts
-   * import { pipe, Context } from "effect"
+   * import { Context, pipe } from "effect"
    * import * as assert from "node:assert"
    *
    * const Port = Context.Service<{ PORT: number }>("Port")
@@ -654,8 +778,8 @@ export const add: {
    * assert.deepStrictEqual(Context.get(context, Timeout), { TIMEOUT: 5000 })
    * ```
    *
-   * @since 4.0.0
    * @category Adders
+   * @since 2.0.0
    */
   <Services, I, S>(self: Context<Services>, key: Key<I, S>, service: Types.NoInfer<S>): Context<Services | I>
 } = dual(3, <Services, I, S>(
@@ -668,18 +792,39 @@ export const add: {
   }))
 
 /**
- * @since 4.0.0
+ * Adds or removes a service depending on an `Option`.
+ *
+ * **Details**
+ *
+ * When `service` is `Option.some`, the value is stored for the key. When it is
+ * `Option.none`, the key is removed from the returned `Context`.
+ *
  * @category Adders
+ * @since 4.0.0
  */
 export const addOrOmit: {
   /**
-   * @since 4.0.0
+   * Adds or removes a service depending on an `Option`.
+   *
+   * **Details**
+   *
+   * When `service` is `Option.some`, the value is stored for the key. When it is
+   * `Option.none`, the key is removed from the returned `Context`.
+   *
    * @category Adders
+   * @since 4.0.0
    */
   <I, S>(key: Key<I, S>, service: Option.Option<Types.NoInfer<S>>): <Services>(self: Context<Services>) => Context<Services | I>
   /**
-   * @since 4.0.0
+   * Adds or removes a service depending on an `Option`.
+   *
+   * **Details**
+   *
+   * When `service` is `Option.some`, the value is stored for the key. When it is
+   * `Option.none`, the key is removed from the returned `Context`.
+   *
    * @category Adders
+   * @since 4.0.0
    */
   <Services, I, S>(
     self: Context<Services>,
@@ -700,13 +845,18 @@ export const addOrOmit: {
   }))
 
 /**
- * Get a service from the context that corresponds to the given key, or
- * use the fallback value.
+ * Gets the service for a key, or evaluates the fallback when a non-reference
+ * key is absent.
+ *
+ * **Details**
+ *
+ * If the key is a `Context.Reference` and no override is stored in the
+ * context, its cached default value is returned instead of the fallback.
+ *
+ * **Example** (Falling back for missing services)
  *
- * @example
  * ```ts
  * import { Context } from "effect"
- * import * as assert from "node:assert"
  *
  * const Logger = Context.Service<{ log: (msg: string) => void }>("Logger")
  * const Database = Context.Service<{ query: (sql: string) => string }>(
@@ -724,22 +874,27 @@ export const addOrOmit: {
  *   () => ({ query: () => "fallback" })
  * )
  *
- * assert.deepStrictEqual(logger, { log: (msg: string) => console.log(msg) })
- * assert.deepStrictEqual(database, { query: () => "fallback" })
+ * console.log(logger === Context.get(context, Logger)) // true
+ * console.log(database.query("SELECT 1")) // "fallback"
  * ```
  *
- * @since 4.0.0
- * @category Getters
+ * @category getters
+ * @since 3.7.0
  */
 export const getOrElse: {
   /**
-   * Get a service from the context that corresponds to the given key, or
-   * use the fallback value.
+   * Gets the service for a key, or evaluates the fallback when a non-reference
+   * key is absent.
+   *
+   * **Details**
+   *
+   * If the key is a `Context.Reference` and no override is stored in the
+   * context, its cached default value is returned instead of the fallback.
+   *
+   * **Example** (Falling back for missing services)
    *
-   * @example
    * ```ts
    * import { Context } from "effect"
-   * import * as assert from "node:assert"
    *
    * const Logger = Context.Service<{ log: (msg: string) => void }>("Logger")
    * const Database = Context.Service<{ query: (sql: string) => string }>(
@@ -757,22 +912,27 @@ export const getOrElse: {
    *   () => ({ query: () => "fallback" })
    * )
    *
-   * assert.deepStrictEqual(logger, { log: (msg: string) => console.log(msg) })
-   * assert.deepStrictEqual(database, { query: () => "fallback" })
+   * console.log(logger === Context.get(context, Logger)) // true
+   * console.log(database.query("SELECT 1")) // "fallback"
    * ```
    *
-   * @since 4.0.0
-   * @category Getters
+   * @category getters
+   * @since 3.7.0
    */
   <S, I, B>(key: Key<I, S>, orElse: LazyArg<B>): <Services>(self: Context<Services>) => S | B
   /**
-   * Get a service from the context that corresponds to the given key, or
-   * use the fallback value.
+   * Gets the service for a key, or evaluates the fallback when a non-reference
+   * key is absent.
+   *
+   * **Details**
+   *
+   * If the key is a `Context.Reference` and no override is stored in the
+   * context, its cached default value is returned instead of the fallback.
+   *
+   * **Example** (Falling back for missing services)
    *
-   * @example
    * ```ts
    * import { Context } from "effect"
-   * import * as assert from "node:assert"
    *
    * const Logger = Context.Service<{ log: (msg: string) => void }>("Logger")
    * const Database = Context.Service<{ query: (sql: string) => string }>(
@@ -790,12 +950,12 @@ export const getOrElse: {
    *   () => ({ query: () => "fallback" })
    * )
    *
-   * assert.deepStrictEqual(logger, { log: (msg: string) => console.log(msg) })
-   * assert.deepStrictEqual(database, { query: () => "fallback" })
+   * console.log(logger === Context.get(context, Logger)) // true
+   * console.log(database.query("SELECT 1")) // "fallback"
    * ```
    *
-   * @since 4.0.0
-   * @category Getters
+   * @category getters
+   * @since 3.7.0
    */
   <Services, S, I, B>(self: Context<Services>, key: Key<I, S>, orElse: LazyArg<B>): S | B
 } = dual(3, <Services, S, I, B>(self: Context<Services>, key: Key<I, S>, orElse: LazyArg<B>): S | B => {
@@ -806,18 +966,42 @@ export const getOrElse: {
 })
 
 /**
+ * Returns the service currently stored for a key, or `undefined` when the key
+ * is absent.
+ *
+ * **Notes**
+ *
+ * This is a raw lookup and does not resolve default values for
+ * `Context.Reference` keys.
+ *
+ * @category getters
  * @since 4.0.0
- * @category Getters
  */
 export const getOrUndefined: {
   /**
+   * Returns the service currently stored for a key, or `undefined` when the key
+   * is absent.
+   *
+   * **Notes**
+   *
+   * This is a raw lookup and does not resolve default values for
+   * `Context.Reference` keys.
+   *
+   * @category getters
    * @since 4.0.0
-   * @category Getters
    */
   <S, I>(key: Key<I, S>): <Services>(self: Context<Services>) => S | undefined
   /**
+   * Returns the service currently stored for a key, or `undefined` when the key
+   * is absent.
+   *
+   * **Notes**
+   *
+   * This is a raw lookup and does not resolve default values for
+   * `Context.Reference` keys.
+   *
+   * @category getters
    * @since 4.0.0
-   * @category Getters
    */
   <Services, S, I>(self: Context<Services>, key: Key<I, S>): S | undefined
 } = dual(
@@ -826,17 +1010,19 @@ export const getOrUndefined: {
 )
 
 /**
- * Get a service from the context that corresponds to the given key.
+ * Gets the service for a key, throwing if an absent non-reference key cannot be
+ * resolved.
  *
- * This function is unsafe because if the key is not present in the context, a
- * runtime error will be thrown.
+ * **Details**
+ *
+ * If the key is a `Context.Reference` and no override is stored in the
+ * context, its cached default value is returned. For absent non-reference keys,
+ * this function throws a runtime error.
  *
  * For a safer version see {@link getOption}.
  *
- * @param self - The `Context` to search for the service.
- * @param service - The `Service` of the service to retrieve.
+ * **Example** (Getting services unsafely)
  *
- * @example
  * ```ts
  * import { Context } from "effect"
  * import * as assert from "node:assert"
@@ -850,22 +1036,24 @@ export const getOrUndefined: {
  * assert.throws(() => Context.getUnsafe(context, Timeout))
  * ```
  *
- * @since 4.0.0
  * @category unsafe
+ * @since 4.0.0
  */
 export const getUnsafe: {
   /**
-   * Get a service from the context that corresponds to the given key.
+   * Gets the service for a key, throwing if an absent non-reference key cannot be
+   * resolved.
+   *
+   * **Details**
    *
-   * This function is unsafe because if the key is not present in the context, a
-   * runtime error will be thrown.
+   * If the key is a `Context.Reference` and no override is stored in the
+   * context, its cached default value is returned. For absent non-reference keys,
+   * this function throws a runtime error.
    *
    * For a safer version see {@link getOption}.
    *
-   * @param self - The `Context` to search for the service.
-   * @param service - The `Service` of the service to retrieve.
+   * **Example** (Getting services unsafely)
    *
-   * @example
    * ```ts
    * import { Context } from "effect"
    * import * as assert from "node:assert"
@@ -879,22 +1067,24 @@ export const getUnsafe: {
    * assert.throws(() => Context.getUnsafe(context, Timeout))
    * ```
    *
-   * @since 4.0.0
    * @category unsafe
+   * @since 4.0.0
    */
   <S, I>(service: Key<I, S>): <Services>(self: Context<Services>) => S
   /**
-   * Get a service from the context that corresponds to the given key.
+   * Gets the service for a key, throwing if an absent non-reference key cannot be
+   * resolved.
    *
-   * This function is unsafe because if the key is not present in the context, a
-   * runtime error will be thrown.
+   * **Details**
+   *
+   * If the key is a `Context.Reference` and no override is stored in the
+   * context, its cached default value is returned. For absent non-reference keys,
+   * this function throws a runtime error.
    *
    * For a safer version see {@link getOption}.
    *
-   * @param self - The `Context` to search for the service.
-   * @param service - The `Service` of the service to retrieve.
+   * **Example** (Getting services unsafely)
    *
-   * @example
    * ```ts
    * import { Context } from "effect"
    * import * as assert from "node:assert"
@@ -908,8 +1098,8 @@ export const getUnsafe: {
    * assert.throws(() => Context.getUnsafe(context, Timeout))
    * ```
    *
-   * @since 4.0.0
    * @category unsafe
+   * @since 4.0.0
    */
   <Services, S, I>(self: Context<Services>, services: Key<I, S>): S
 } = dual(
@@ -926,12 +1116,10 @@ export const getUnsafe: {
 /**
  * Get a service from the context that corresponds to the given key.
  *
- * @param self - The `Context` to search for the service.
- * @param service - The `Service` of the service to retrieve.
+ * **Example** (Getting a service from a context)
  *
- * @example
  * ```ts
- * import { pipe, Context } from "effect"
+ * import { Context, pipe } from "effect"
  * import * as assert from "node:assert"
  *
  * const Port = Context.Service<{ PORT: number }>("Port")
@@ -945,19 +1133,17 @@ export const getUnsafe: {
  * assert.deepStrictEqual(Context.get(context, Timeout), { TIMEOUT: 5000 })
  * ```
  *
- * @since 4.0.0
- * @category Getters
+ * @category getters
+ * @since 2.0.0
  */
 export const get: {
   /**
    * Get a service from the context that corresponds to the given key.
    *
-   * @param self - The `Context` to search for the service.
-   * @param service - The `Service` of the service to retrieve.
+   * **Example** (Getting a service from a context)
    *
-   * @example
    * ```ts
-   * import { pipe, Context } from "effect"
+   * import { Context, pipe } from "effect"
    * import * as assert from "node:assert"
    *
    * const Port = Context.Service<{ PORT: number }>("Port")
@@ -971,19 +1157,17 @@ export const get: {
    * assert.deepStrictEqual(Context.get(context, Timeout), { TIMEOUT: 5000 })
    * ```
    *
-   * @since 4.0.0
-   * @category Getters
+   * @category getters
+   * @since 2.0.0
    */
   <Services, I extends Services, S>(service: Key<I, S>): (self: Context<Services>) => S
   /**
    * Get a service from the context that corresponds to the given key.
    *
-   * @param self - The `Context` to search for the service.
-   * @param service - The `Service` of the service to retrieve.
+   * **Example** (Getting a service from a context)
    *
-   * @example
    * ```ts
-   * import { pipe, Context } from "effect"
+   * import { Context, pipe } from "effect"
    * import * as assert from "node:assert"
    *
    * const Port = Context.Service<{ PORT: number }>("Port")
@@ -997,17 +1181,20 @@ export const get: {
    * assert.deepStrictEqual(Context.get(context, Timeout), { TIMEOUT: 5000 })
    * ```
    *
-   * @since 4.0.0
-   * @category Getters
+   * @category getters
+   * @since 2.0.0
    */
   <Services, I extends Services, S>(self: Context<Services>, service: Key<I, S>): S
 } = getUnsafe
 
 /**
- * @example
+ * Gets the value for a `Context.Reference`, returning its cached default when
+ * the context does not contain an override.
+ *
+ * **Example** (Getting reference defaults unsafely)
+ *
  * ```ts
  * import { Context } from "effect"
- * import * as assert from "node:assert"
  *
  * const LoggerRef = Context.Reference("Logger", {
  *   defaultValue: () => ({ log: (msg: string) => console.log(msg) })
@@ -1016,11 +1203,11 @@ export const get: {
  * const context = Context.empty()
  * const logger = Context.getReferenceUnsafe(context, LoggerRef)
  *
- * assert.deepStrictEqual(logger, { log: (msg: string) => console.log(msg) })
+ * console.log(typeof logger.log) // "function"
  * ```
  *
- * @since 4.0.0
  * @category unsafe
+ * @since 4.0.0
  */
 export const getReferenceUnsafe = <Services, S>(self: Context<Services>, service: Reference<S>): S => {
   if (!self.mapUnsafe.has(service.key)) {
@@ -1060,16 +1247,18 @@ const serviceNotFoundError = (service: Key<any, any>) => {
 }
 
 /**
- * Get the value associated with the specified key from the context wrapped in
- * an `Option` object. If the key is not found, the `Option` object will be
- * `None`.
+ * Gets the service for a key wrapped in an `Option`.
  *
- * @param self - The `Context` to search for the service.
- * @param service - The `Service` of the service to retrieve.
+ * **Details**
+ *
+ * Returns `Option.some` when the service is stored in the context. If the key
+ * is a `Context.Reference` and no override is stored, returns `Option.some` of
+ * the cached default value. Missing non-reference keys return `Option.none`.
+ *
+ * **Example** (Getting optional services)
  *
- * @example
  * ```ts
- * import { Option, Context } from "effect"
+ * import { Context, Option } from "effect"
  * import * as assert from "node:assert"
  *
  * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1084,21 +1273,23 @@ const serviceNotFoundError = (service: Key<any, any>) => {
  * assert.deepStrictEqual(Context.getOption(context, Timeout), Option.none())
  * ```
  *
- * @since 4.0.0
- * @category Getters
+ * @category getters
+ * @since 2.0.0
  */
 export const getOption: {
   /**
-   * Get the value associated with the specified key from the context wrapped in
-   * an `Option` object. If the key is not found, the `Option` object will be
-   * `None`.
+   * Gets the service for a key wrapped in an `Option`.
+   *
+   * **Details**
    *
-   * @param self - The `Context` to search for the service.
-   * @param service - The `Service` of the service to retrieve.
+   * Returns `Option.some` when the service is stored in the context. If the key
+   * is a `Context.Reference` and no override is stored, returns `Option.some` of
+   * the cached default value. Missing non-reference keys return `Option.none`.
+   *
+   * **Example** (Getting optional services)
    *
-   * @example
    * ```ts
-   * import { Option, Context } from "effect"
+   * import { Context, Option } from "effect"
    * import * as assert from "node:assert"
    *
    * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1113,21 +1304,23 @@ export const getOption: {
    * assert.deepStrictEqual(Context.getOption(context, Timeout), Option.none())
    * ```
    *
-   * @since 4.0.0
-   * @category Getters
+   * @category getters
+   * @since 2.0.0
    */
   <S, I>(service: Key<I, S>): <Services>(self: Context<Services>) => Option.Option<S>
   /**
-   * Get the value associated with the specified key from the context wrapped in
-   * an `Option` object. If the key is not found, the `Option` object will be
-   * `None`.
+   * Gets the service for a key wrapped in an `Option`.
+   *
+   * **Details**
    *
-   * @param self - The `Context` to search for the service.
-   * @param service - The `Service` of the service to retrieve.
+   * Returns `Option.some` when the service is stored in the context. If the key
+   * is a `Context.Reference` and no override is stored, returns `Option.some` of
+   * the cached default value. Missing non-reference keys return `Option.none`.
+   *
+   * **Example** (Getting optional services)
    *
-   * @example
    * ```ts
-   * import { Option, Context } from "effect"
+   * import { Context, Option } from "effect"
    * import * as assert from "node:assert"
    *
    * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1142,8 +1335,8 @@ export const getOption: {
    * assert.deepStrictEqual(Context.getOption(context, Timeout), Option.none())
    * ```
    *
-   * @since 4.0.0
-   * @category Getters
+   * @category getters
+   * @since 2.0.0
    */
   <Services, S, I>(self: Context<Services>, service: Key<I, S>): Option.Option<S>
 } = dual(2, <Services, I extends Services, S>(self: Context<Services>, service: Key<I, S>): Option.Option<S> => {
@@ -1154,12 +1347,15 @@ export const getOption: {
 })
 
 /**
- * Merges two `Context`s, returning a new `Context` containing the services of both.
+ * Merges two `Context`s into one.
  *
- * @param self - The first `Context` to merge.
- * @param that - The second `Context` to merge.
+ * **Details**
+ *
+ * When both contexts contain the same service key, the service from `that`
+ * overrides the service from `self`.
+ *
+ * **Example** (Merging two contexts)
  *
- * @example
  * ```ts
  * import { Context } from "effect"
  * import * as assert from "node:assert"
@@ -1176,17 +1372,20 @@ export const getOption: {
  * assert.deepStrictEqual(Context.get(context, Timeout), { TIMEOUT: 5000 })
  * ```
  *
- * @since 4.0.0
  * @category Utils
+ * @since 2.0.0
  */
 export const merge: {
   /**
-   * Merges two `Context`s, returning a new `Context` containing the services of both.
+   * Merges two `Context`s into one.
+   *
+   * **Details**
+   *
+   * When both contexts contain the same service key, the service from `that`
+   * overrides the service from `self`.
    *
-   * @param self - The first `Context` to merge.
-   * @param that - The second `Context` to merge.
+   * **Example** (Merging two contexts)
    *
-   * @example
    * ```ts
    * import { Context } from "effect"
    * import * as assert from "node:assert"
@@ -1203,17 +1402,20 @@ export const merge: {
    * assert.deepStrictEqual(Context.get(context, Timeout), { TIMEOUT: 5000 })
    * ```
    *
-   * @since 4.0.0
    * @category Utils
+   * @since 2.0.0
    */
   <R1>(that: Context<R1>): <Services>(self: Context<Services>) => Context<R1 | Services>
   /**
-   * Merges two `Context`s, returning a new `Context` containing the services of both.
+   * Merges two `Context`s into one.
+   *
+   * **Details**
+   *
+   * When both contexts contain the same service key, the service from `that`
+   * overrides the service from `self`.
    *
-   * @param self - The first `Context` to merge.
-   * @param that - The second `Context` to merge.
+   * **Example** (Merging two contexts)
    *
-   * @example
    * ```ts
    * import { Context } from "effect"
    * import * as assert from "node:assert"
@@ -1230,8 +1432,8 @@ export const merge: {
    * assert.deepStrictEqual(Context.get(context, Timeout), { TIMEOUT: 5000 })
    * ```
    *
-   * @since 4.0.0
    * @category Utils
+   * @since 2.0.0
    */
   <Services, R1>(self: Context<Services>, that: Context<R1>): Context<Services | R1>
 } = dual(2, <Services, R1>(self: Context<Services>, that: Context<R1>): Context<Services | R1> => {
@@ -1243,9 +1445,15 @@ export const merge: {
 })
 
 /**
- * Merges any number of `Context`s, returning a new `Context` containing the services of all.
+ * Merges any number of `Context`s into one.
+ *
+ * **Details**
+ *
+ * When multiple contexts contain the same service key, the service from the
+ * last context with that key is kept.
+ *
+ * **Example** (Merging multiple contexts)
  *
- * @example
  * ```ts
  * import { Context } from "effect"
  * import * as assert from "node:assert"
@@ -1269,6 +1477,7 @@ export const merge: {
  * assert.deepStrictEqual(Context.get(context, Host), { HOST: "localhost" })
  * ```
  *
+ * @category combining
  * @since 3.12.0
  */
 export const mergeAll = <T extends Array<unknown>>(
@@ -1286,12 +1495,10 @@ export const mergeAll = <T extends Array<unknown>>(
 /**
  * Returns a new `Context` that contains only the specified services.
  *
- * @param self - The `Context` to prune services from.
- * @param services - The list of `Service`s to be included in the new `Context`.
+ * **Example** (Picking services from a context)
  *
- * @example
  * ```ts
- * import { Option, pipe, Context } from "effect"
+ * import { Context, Option, pipe } from "effect"
  * import * as assert from "node:assert"
  *
  * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1311,8 +1518,8 @@ export const mergeAll = <T extends Array<unknown>>(
  * assert.deepStrictEqual(Context.getOption(context, Timeout), Option.none())
  * ```
  *
- * @since 4.0.0
  * @category Utils
+ * @since 2.0.0
  */
 export const pick = <S extends ReadonlyArray<Key<any, any>>>(
   ...services: S
@@ -1327,9 +1534,12 @@ export const pick = <S extends ReadonlyArray<Key<any, any>>>(
   })
 
 /**
- * @example
+ * Returns a new `Context` with the specified service keys removed.
+ *
+ * **Example** (Omitting services from a context)
+ *
  * ```ts
- * import { Option, pipe, Context } from "effect"
+ * import { Context, Option, pipe } from "effect"
  * import * as assert from "node:assert"
  *
  * const Port = Context.Service<{ PORT: number }>("Port")
@@ -1349,8 +1559,8 @@ export const pick = <S extends ReadonlyArray<Key<any, any>>>(
  * assert.deepStrictEqual(Context.getOption(context, Timeout), Option.none())
  * ```
  *
- * @since 4.0.0
  * @category Utils
+ * @since 2.0.0
  */
 export const omit = <S extends ReadonlyArray<Key<any, any>>>(
   ...keys: S
@@ -1366,24 +1576,24 @@ export const omit = <S extends ReadonlyArray<Key<any, any>>>(
  * Perform a series of mutations on a `Context`. Prevents unnecessary copying
  * of the underlying map when multiple mutations are needed.
  *
- * @since 4.0.0
  * @category Utils
+ * @since 4.0.0
  */
 export const mutate: {
   /**
    * Perform a series of mutations on a `Context`. Prevents unnecessary copying
    * of the underlying map when multiple mutations are needed.
    *
-   * @since 4.0.0
    * @category Utils
+   * @since 4.0.0
    */
   <Services, B>(f: (context: Context<Services>) => Context<B>): <Services>(self: Context<Services>) => Context<B>
   /**
    * Perform a series of mutations on a `Context`. Prevents unnecessary copying
    * of the underlying map when multiple mutations are needed.
    *
-   * @since 4.0.0
    * @category Utils
+   * @since 4.0.0
    */
   <Services, B>(self: Context<Services>, f: (context: Context<Services>) => Context<B>): Context<B>
 } = dual(
@@ -1393,8 +1603,8 @@ export const mutate: {
      * Perform a series of mutations on a `Context`. Prevents unnecessary copying
      * of the underlying map when multiple mutations are needed.
      *
-     * @since 4.0.0
      * @category Utils
+     * @since 4.0.0
      */
     Services>(new Map(self.mapUnsafe))
     next.mutable = true
@@ -1424,7 +1634,8 @@ const withMapUnsafe = <Services, B>(self: Context<Services>, f: (map: Map<string
  * when the context is accessed, or override it with a custom implementation
  * when needed.
  *
- * @example
+ * **Example** (Creating references with default values)
+ *
  * ```ts
  * import { Context } from "effect"
  *
@@ -1444,8 +1655,8 @@ const withMapUnsafe = <Services, B>(self: Context<Services>, f: (map: Map<string
  * const customLogger = Context.get(customContext, LoggerRef)
  * ```
  *
- * @since 4.0.0
- * @category References
+ * @category references
+ * @since 3.11.0
  */
 export const Reference: <Service>(
   key: string,