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

package/dist/Scope.d.ts

@@ -23,7 +23,8 @@ declare const CloseableTypeId = "~effect/Scope/Closeable";
  * automatically cleaned up when the scope is closed. Scopes can use
  * either sequential or parallel finalization strategies.
  *
- * @example
+ * **Example** (Managing scoped resources)
+ *
  * ```ts
  * import { Effect, Exit, Scope } from "effect"
  *
@@ -40,8 +41,8 @@ declare const CloseableTypeId = "~effect/Scope/Closeable";
  * })
  * ```
  *
- * @since 2.0.0
  * @category models
+ * @since 2.0.0
  */
 export interface Scope {
     readonly [TypeId]: typeof TypeId;
@@ -52,7 +53,8 @@ export interface Scope {
  * A `Closeable` scope extends the base `Scope` interface with the ability
  * to be closed, executing all registered finalizers.
  *
- * @example
+ * **Example** (Closing a scope)
+ *
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -67,17 +69,19 @@ export interface Scope {
  * })
  * ```
  *
- * @since 2.0.0
  * @category models
+ * @since 2.0.0
  */
 export interface Closeable extends Scope {
     readonly [CloseableTypeId]: typeof CloseableTypeId;
 }
 /**
- * The `State` namespace contains types representing the different states
- * a scope can be in: Open (accepting new finalizers) or Closed (no longer accepting finalizers).
+ * The `State` namespace contains the concrete states of a scope: `Empty`
+ * before any finalizers are registered, `Open` with registered finalizers, and
+ * `Closed` with the exit value used to close the scope.
+ *
+ * **Example** (Checking scope states)
  *
- * @example
  * ```ts
  * import { Effect, Exit, Scope } from "effect"
  *
@@ -99,15 +103,18 @@ export interface Closeable extends Scope {
  * })
  * ```
  *
- * @since 2.0.0
- * @category models
+ * @since 4.0.0
  */
 export declare namespace State {
     /**
-     * Represents an open scope state where finalizers can be added and
-     * the scope is still accepting new resources.
+     * Represents an open scope with no registered finalizers yet.
+     *
+     * Adding the first finalizer transitions the scope to `Open`; closing an
+     * empty scope transitions directly to `Closed` without producing a finalizer
+     * effect.
+     *
+     * **Example** (Inspecting an empty scope state)
      *
-     * @example
      * ```ts
      * import { Scope } from "effect"
      *
@@ -120,8 +127,8 @@ export declare namespace State {
      * }
      * ```
      *
-     * @since 2.0.0
      * @category models
+     * @since 4.0.0
      */
     type Empty = {
         readonly _tag: "Empty";
@@ -130,7 +137,8 @@ export declare namespace State {
      * Represents an open scope state where finalizers can be added and
      * the scope is still accepting new resources.
      *
-     * @example
+     * **Example** (Inspecting an open scope state)
+     *
      * ```ts
      * import { Scope } from "effect"
      *
@@ -143,8 +151,8 @@ export declare namespace State {
      * }
      * ```
      *
-     * @since 2.0.0
      * @category models
+     * @since 4.0.0
      */
     type Open = {
         readonly _tag: "Open";
@@ -154,7 +162,8 @@ export declare namespace State {
      * Represents a closed scope state where finalizers have been executed
      * and the scope is no longer accepting new resources.
      *
-     * @example
+     * **Example** (Inspecting a closed scope state)
+     *
      * ```ts
      * import { Effect, Exit, Scope } from "effect"
      *
@@ -172,8 +181,8 @@ export declare namespace State {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category models
+     * @since 4.0.0
      */
     type Closed = {
         readonly _tag: "Closed";
@@ -183,7 +192,8 @@ export declare namespace State {
 /**
  * The service tag for `Scope`, used for dependency injection in the Effect system.
  *
- * @example
+ * **Example** (Accessing the scope service)
+ *
  * ```ts
  * import { Effect, Scope } from "effect"
  *
@@ -199,14 +209,15 @@ export declare namespace State {
  * const scoped = Effect.scoped(program)
  * ```
  *
- * @since 2.0.0
  * @category tags
+ * @since 2.0.0
  */
 export declare const Scope: Context.Service<Scope, Scope>;
 /**
  * Creates a new `Scope` with the specified finalizer strategy.
  *
- * @example
+ * **Example** (Creating a scope)
+ *
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -233,7 +244,8 @@ export declare const make: (finalizerStrategy?: "sequential" | "parallel") => Ef
  * This is useful when you need a scope immediately but should be used with caution
  * as it doesn't provide the same safety guarantees as the `Effect`-wrapped version.
  *
- * @example
+ * **Example** (Creating a scope synchronously)
+ *
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -247,21 +259,16 @@ export declare const make: (finalizerStrategy?: "sequential" | "parallel") => Ef
  * })
  * ```
  *
- * @since 4.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export declare const makeUnsafe: (finalizerStrategy?: "sequential" | "parallel") => Closeable;
 /**
  * Provides a `Scope` to an `Effect`, removing the `Scope` requirement from its context.
  * This allows you to run effects that require a scope by explicitly providing one.
  *
- * **Previously Known As**
- *
- * This API replaces the following from Effect 3.x:
- *
- * - `Scope.extend`
+ * **Example** (Providing a scope)
  *
- * @example
  * ```ts
  * import { Console, Effect, Scope } from "effect"
  *
@@ -279,21 +286,16 @@ export declare const makeUnsafe: (finalizerStrategy?: "sequential" | "parallel")
  * })
  * ```
  *
- * @since 4.0.0
  * @category combinators
+ * @since 4.0.0
  */
 export declare const provide: {
     /**
      * Provides a `Scope` to an `Effect`, removing the `Scope` requirement from its context.
      * This allows you to run effects that require a scope by explicitly providing one.
      *
-     * **Previously Known As**
+     * **Example** (Providing a scope)
      *
-     * This API replaces the following from Effect 3.x:
-     *
-     * - `Scope.extend`
-     *
-     * @example
      * ```ts
      * import { Console, Effect, Scope } from "effect"
      *
@@ -311,21 +313,16 @@ export declare const provide: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category combinators
+     * @since 4.0.0
      */
     (value: Scope): <A, E, R>(self: Effect<A, E, R>) => Effect<A, E, Exclude<R, Scope>>;
     /**
      * Provides a `Scope` to an `Effect`, removing the `Scope` requirement from its context.
      * This allows you to run effects that require a scope by explicitly providing one.
      *
-     * **Previously Known As**
+     * **Example** (Providing a scope)
      *
-     * This API replaces the following from Effect 3.x:
-     *
-     * - `Scope.extend`
-     *
-     * @example
      * ```ts
      * import { Console, Effect, Scope } from "effect"
      *
@@ -343,16 +340,20 @@ export declare const provide: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category combinators
+     * @since 4.0.0
      */
     <A, E, R>(self: Effect<A, E, R>, value: Scope): Effect<A, E, Exclude<R, Scope>>;
 };
 /**
- * Adds a finalizer to a scope that will be executed when the scope is closed.
- * Finalizers are cleanup functions that receive the exit value of the scope.
+ * Registers an exit-aware finalizer on a scope.
+ *
+ * If the scope is open, the finalizer runs when the scope closes and receives
+ * the scope's exit value. If the scope is already closed, the finalizer runs
+ * immediately with the stored exit value.
+ *
+ * **Example** (Adding an exit-aware finalizer)
  *
- * @example
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -379,15 +380,18 @@ export declare const provide: {
  * ```
  *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export declare const addFinalizerExit: (scope: Scope, finalizer: (exit: Exit<any, any>) => Effect<unknown>) => Effect<void>;
 /**
- * Adds a finalizer to a scope. The finalizer is a simple `Effect` that will be
- * executed when the scope is closed, regardless of whether the scope closes
- * successfully or with an error.
+ * Registers a finalizer effect on a scope.
+ *
+ * If the scope is open, the finalizer runs when the scope closes, regardless of
+ * whether the scope closes successfully or with an error. If the scope is
+ * already closed, the finalizer runs immediately.
+ *
+ * **Example** (Adding finalizers)
  *
- * @example
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -407,15 +411,19 @@ export declare const addFinalizerExit: (scope: Scope, finalizer: (exit: Exit<any
  * })
  * ```
  *
- * @since 4.0.0
  * @category combinators
+ * @since 2.0.0
  */
 export declare const addFinalizer: (scope: Scope, finalizer: Effect<unknown>) => Effect<void>;
 /**
- * Creates a child scope from a parent scope. The child scope inherits the
- * parent's finalization strategy unless overridden.
+ * Creates a closeable child scope registered with a parent scope.
+ *
+ * Closing the parent closes the child with the same exit value, and closing the
+ * child detaches it from the parent. The optional finalizer strategy configures
+ * the child scope and defaults to `"sequential"` when omitted.
+ *
+ * **Example** (Creating a child scope)
  *
- * @example
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -438,14 +446,18 @@ export declare const addFinalizer: (scope: Scope, finalizer: Effect<unknown>) =>
  * ```
  *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export declare const fork: (scope: Scope, finalizerStrategy?: "sequential" | "parallel") => Effect<Closeable>;
 /**
- * Creates a child scope from a parent scope synchronously without wrapping it in an `Effect`.
- * The child scope inherits the parent's finalization strategy unless overridden.
+ * Synchronously creates a closeable child scope registered with a parent scope.
+ *
+ * Closing the parent closes the child with the same exit value, and closing the
+ * child detaches it from the parent. The optional finalizer strategy configures
+ * the child scope and defaults to `"sequential"` when omitted.
+ *
+ * **Example** (Creating a child scope synchronously)
  *
- * @example
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -463,15 +475,16 @@ export declare const fork: (scope: Scope, finalizerStrategy?: "sequential" | "pa
  * })
  * ```
  *
- * @since 4.0.0
  * @category combinators
+ * @since 4.0.0
  */
 export declare const forkUnsafe: (scope: Scope, finalizerStrategy?: "sequential" | "parallel") => Closeable;
 /**
  * Closes a scope, running all registered finalizers in the appropriate order.
  * The exit value is passed to each finalizer.
  *
- * @example
+ * **Example** (Running scope finalizers)
+ *
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -493,26 +506,55 @@ export declare const forkUnsafe: (scope: Scope, finalizerStrategy?: "sequential"
  * ```
  *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export declare const close: <A, E>(self: Scope, exit: Exit<A, E>) => Effect<void>;
 /**
+ * Unsafely transitions a scope to `Closed` with the provided exit value.
+ *
+ * Returns an effect that runs registered finalizers, or `undefined` when the
+ * scope was already closed or no finalizers need to run. Prefer `close` unless
+ * you are implementing lower-level scope machinery and can correctly run the
+ * returned effect.
+ *
+ * @category unsafe
  * @since 4.0.0
  */
 export declare const closeUnsafe: <A, E>(self: Scope, exit_: Exit<A, E>) => Effect<void, never, never> | undefined;
 /**
+ * Runs an effect with the provided closeable scope in its context and closes
+ * that scope when the effect exits.
+ *
+ * The scope is closed with the same exit value as the effect, so registered
+ * finalizers can observe whether the effect succeeded, failed, or was
+ * interrupted.
+ *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export declare const use: {
     /**
+     * Runs an effect with the provided closeable scope in its context and closes
+     * that scope when the effect exits.
+     *
+     * The scope is closed with the same exit value as the effect, so registered
+     * finalizers can observe whether the effect succeeded, failed, or was
+     * interrupted.
+     *
      * @category combinators
-     * @since 4.0.0
+     * @since 2.0.0
      */
     (scope: Closeable): <A, E, R>(self: Effect<A, E, R>) => Effect<A, E, Exclude<R, Scope>>;
     /**
+     * Runs an effect with the provided closeable scope in its context and closes
+     * that scope when the effect exits.
+     *
+     * The scope is closed with the same exit value as the effect, so registered
+     * finalizers can observe whether the effect succeeded, failed, or was
+     * interrupted.
+     *
      * @category combinators
-     * @since 4.0.0
+     * @since 2.0.0
      */
     <A, E, R>(self: Effect<A, E, R>, scope: Closeable): Effect<A, E, Exclude<R, Scope>>;
 };

package/dist/Scope.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Scope.d.ts","sourceRoot":"","sources":["../src/Scope.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAGrC,QAAA,MAAM,MAAM,kBAAqB,CAAA;AACjC,QAAA,MAAM,eAAe,4BAA8B,CAAA;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,QAAQ,EAAE,YAAY,GAAG,UAAU,CAAA;IAC5C,KAAK,EAAE,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAA;CAC/C;AACD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,SAAU,SAAQ,KAAK;IACtC,QAAQ,CAAC,CAAC,eAAe,CAAC,EAAE,OAAO,eAAe,CAAA;CACnD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,yBAAiB,KAAK,CAAC;IACrB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAY,KAAK,GAAG;QAClB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;KACvB,CAAA;IACD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAY,IAAI,GAAG;QACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;KACrE,CAAA;IACD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAY,MAAM,GAAG;QACnB,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;QACvB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;KAC9B,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAmB,CAAA;AAEnE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,IAAI,EAAE,CAAC,iBAAiB,CAAC,EAAE,YAAY,GAAG,UAAU,KAAK,MAAM,CAAC,SAAS,CAAoB,CAAA;AAE1G;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,UAAU,EAAE,CAAC,iBAAiB,CAAC,EAAE,YAAY,GAAG,UAAU,KAAK,SAAkC,CAAA;AAE9G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;IACnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;CAC1D,CAAA;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,OAAO,CAAC,KAAK,MAAM,CAAC,IAAI,CACpF,CAAA;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,MAAM,CAAC,IAAI,CAA4B,CAAA;AAEhH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,IAAI,EAAE,CACjB,KAAK,EAAE,KAAK,EACZ,iBAAiB,CAAC,EAAE,YAAY,GAAG,UAAU,KAC1C,MAAM,CAAC,SAAS,CAAoB,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,iBAAiB,CAAC,EAAE,YAAY,GAAG,UAAU,KAAK,SAClE,CAAA;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,IAAI,CAAqB,CAAA;AAE7F;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,SACxE,CAAA;AAEzB;;;GAGG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;OAGG;IACH,CAAC,KAAK,EAAE,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;IACvF;;;OAGG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;CAClE,CAAA"}
+{"version":3,"file":"Scope.d.ts","sourceRoot":"","sources":["../src/Scope.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAGrC,QAAA,MAAM,MAAM,kBAAqB,CAAA;AACjC,QAAA,MAAM,eAAe,4BAA8B,CAAA;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,QAAQ,EAAE,YAAY,GAAG,UAAU,CAAA;IAC5C,KAAK,EAAE,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAA;CAC/C;AACD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,SAAU,SAAQ,KAAK;IACtC,QAAQ,CAAC,CAAC,eAAe,CAAC,EAAE,OAAO,eAAe,CAAA;CACnD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,yBAAiB,KAAK,CAAC;IACrB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAY,KAAK,GAAG;QAClB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;KACvB,CAAA;IACD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAY,IAAI,GAAG;QACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;KACrE,CAAA;IACD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAY,MAAM,GAAG;QACnB,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;QACvB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;KAC9B,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAmB,CAAA;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,IAAI,EAAE,CAAC,iBAAiB,CAAC,EAAE,YAAY,GAAG,UAAU,KAAK,MAAM,CAAC,SAAS,CAAoB,CAAA;AAE1G;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,UAAU,EAAE,CAAC,iBAAiB,CAAC,EAAE,YAAY,GAAG,UAAU,KAAK,SAAkC,CAAA;AAE9G;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;IACnF;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;CAC1D,CAAA;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,OAAO,CAAC,KAAK,MAAM,CAAC,IAAI,CACpF,CAAA;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,MAAM,CAAC,IAAI,CAA4B,CAAA;AAEhH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,IAAI,EAAE,CACjB,KAAK,EAAE,KAAK,EACZ,iBAAiB,CAAC,EAAE,YAAY,GAAG,UAAU,KAC1C,MAAM,CAAC,SAAS,CAAoB,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,iBAAiB,CAAC,EAAE,YAAY,GAAG,UAAU,KAAK,SAClE,CAAA;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,IAAI,CAAqB,CAAA;AAE7F;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,SACxE,CAAA;AAEzB;;;;;;;;;;GAUG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;OAUG;IACH,CAAC,KAAK,EAAE,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;IACvF;;;;;;;;;;OAUG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;CAClE,CAAA"}

package/dist/Scope.js

@@ -19,7 +19,8 @@ const CloseableTypeId = effect.ScopeCloseableTypeId;
 /**
  * The service tag for `Scope`, used for dependency injection in the Effect system.
  *
- * @example
+ * **Example** (Accessing the scope service)
+ *
  * ```ts
  * import { Effect, Scope } from "effect"
  *
@@ -35,14 +36,15 @@ const CloseableTypeId = effect.ScopeCloseableTypeId;
  * const scoped = Effect.scoped(program)
  * ```
  *
- * @since 2.0.0
  * @category tags
+ * @since 2.0.0
  */
 export const Scope = effect.scopeTag;
 /**
  * Creates a new `Scope` with the specified finalizer strategy.
  *
- * @example
+ * **Example** (Creating a scope)
+ *
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -69,7 +71,8 @@ export const make = effect.scopeMake;
  * This is useful when you need a scope immediately but should be used with caution
  * as it doesn't provide the same safety guarantees as the `Effect`-wrapped version.
  *
- * @example
+ * **Example** (Creating a scope synchronously)
+ *
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -83,21 +86,16 @@ export const make = effect.scopeMake;
  * })
  * ```
  *
- * @since 4.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export const makeUnsafe = effect.scopeMakeUnsafe;
 /**
  * Provides a `Scope` to an `Effect`, removing the `Scope` requirement from its context.
  * This allows you to run effects that require a scope by explicitly providing one.
  *
- * **Previously Known As**
- *
- * This API replaces the following from Effect 3.x:
- *
- * - `Scope.extend`
+ * **Example** (Providing a scope)
  *
- * @example
  * ```ts
  * import { Console, Effect, Scope } from "effect"
  *
@@ -115,15 +113,19 @@ export const makeUnsafe = effect.scopeMakeUnsafe;
  * })
  * ```
  *
- * @since 4.0.0
  * @category combinators
+ * @since 4.0.0
  */
 export const provide = effect.provideScope;
 /**
- * Adds a finalizer to a scope that will be executed when the scope is closed.
- * Finalizers are cleanup functions that receive the exit value of the scope.
+ * Registers an exit-aware finalizer on a scope.
+ *
+ * If the scope is open, the finalizer runs when the scope closes and receives
+ * the scope's exit value. If the scope is already closed, the finalizer runs
+ * immediately with the stored exit value.
+ *
+ * **Example** (Adding an exit-aware finalizer)
  *
- * @example
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -150,15 +152,18 @@ export const provide = effect.provideScope;
  * ```
  *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const addFinalizerExit = effect.scopeAddFinalizerExit;
 /**
- * Adds a finalizer to a scope. The finalizer is a simple `Effect` that will be
- * executed when the scope is closed, regardless of whether the scope closes
- * successfully or with an error.
+ * Registers a finalizer effect on a scope.
+ *
+ * If the scope is open, the finalizer runs when the scope closes, regardless of
+ * whether the scope closes successfully or with an error. If the scope is
+ * already closed, the finalizer runs immediately.
+ *
+ * **Example** (Adding finalizers)
  *
- * @example
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -178,15 +183,19 @@ export const addFinalizerExit = effect.scopeAddFinalizerExit;
  * })
  * ```
  *
- * @since 4.0.0
  * @category combinators
+ * @since 2.0.0
  */
 export const addFinalizer = effect.scopeAddFinalizer;
 /**
- * Creates a child scope from a parent scope. The child scope inherits the
- * parent's finalization strategy unless overridden.
+ * Creates a closeable child scope registered with a parent scope.
+ *
+ * Closing the parent closes the child with the same exit value, and closing the
+ * child detaches it from the parent. The optional finalizer strategy configures
+ * the child scope and defaults to `"sequential"` when omitted.
+ *
+ * **Example** (Creating a child scope)
  *
- * @example
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -209,14 +218,18 @@ export const addFinalizer = effect.scopeAddFinalizer;
  * ```
  *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const fork = effect.scopeFork;
 /**
- * Creates a child scope from a parent scope synchronously without wrapping it in an `Effect`.
- * The child scope inherits the parent's finalization strategy unless overridden.
+ * Synchronously creates a closeable child scope registered with a parent scope.
+ *
+ * Closing the parent closes the child with the same exit value, and closing the
+ * child detaches it from the parent. The optional finalizer strategy configures
+ * the child scope and defaults to `"sequential"` when omitted.
+ *
+ * **Example** (Creating a child scope synchronously)
  *
- * @example
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -234,15 +247,16 @@ export const fork = effect.scopeFork;
  * })
  * ```
  *
- * @since 4.0.0
  * @category combinators
+ * @since 4.0.0
  */
 export const forkUnsafe = effect.scopeForkUnsafe;
 /**
  * Closes a scope, running all registered finalizers in the appropriate order.
  * The exit value is passed to each finalizer.
  *
- * @example
+ * **Example** (Running scope finalizers)
+ *
  * ```ts
  * import { Console, Effect, Exit, Scope } from "effect"
  *
@@ -264,16 +278,31 @@ export const forkUnsafe = effect.scopeForkUnsafe;
  * ```
  *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const close = effect.scopeClose;
 /**
+ * Unsafely transitions a scope to `Closed` with the provided exit value.
+ *
+ * Returns an effect that runs registered finalizers, or `undefined` when the
+ * scope was already closed or no finalizers need to run. Prefer `close` unless
+ * you are implementing lower-level scope machinery and can correctly run the
+ * returned effect.
+ *
+ * @category unsafe
  * @since 4.0.0
  */
 export const closeUnsafe = effect.scopeCloseUnsafe;
 /**
+ * Runs an effect with the provided closeable scope in its context and closes
+ * that scope when the effect exits.
+ *
+ * The scope is closed with the same exit value as the effect, so registered
+ * finalizers can observe whether the effect succeeded, failed, or was
+ * interrupted.
+ *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const use = effect.scopeUse;
 //# sourceMappingURL=Scope.js.map

package/dist/Scope.js.map

@@ -1 +1 @@
-{"version":3,"file":"Scope.js","names":["effect","TypeId","ScopeTypeId","CloseableTypeId","ScopeCloseableTypeId","Scope","scopeTag","make","scopeMake","makeUnsafe","scopeMakeUnsafe","provide","provideScope","addFinalizerExit","scopeAddFinalizerExit","addFinalizer","scopeAddFinalizer","fork","scopeFork","forkUnsafe","scopeForkUnsafe","close","scopeClose","closeUnsafe","scopeCloseUnsafe","use","scopeUse"],"sources":["../src/Scope.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;AAmBA,OAAO,KAAKA,MAAM,MAAM,sBAAsB;AAE9C,MAAMC,MAAM,GAAGD,MAAM,CAACE,WAAW;AACjC,MAAMC,eAAe,GAAGH,MAAM,CAACI,oBAAoB;AAsKnD;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAMC,KAAK,GAAkCL,MAAM,CAACM,QAAQ;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,MAAMC,IAAI,GAAyEP,MAAM,CAACQ,SAAS;AAE1G;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAMC,UAAU,GAAiET,MAAM,CAACU,eAAe;AAE9G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,OAAO,MAAMC,OAAO,GAiEhBX,MAAM,CAACY,YAAY;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,OAAO,MAAMC,gBAAgB,GAC3Bb,MAAM,CAACc,qBAAqB;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,OAAO,MAAMC,YAAY,GAA+Df,MAAM,CAACgB,iBAAiB;AAEhH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,OAAO,MAAMC,IAAI,GAGQjB,MAAM,CAACkB,SAAS;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAMC,UAAU,GACrBnB,MAAM,CAACoB,eAAe;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,OAAO,MAAMC,KAAK,GAA0DrB,MAAM,CAACsB,UAAU;AAE7F;;;AAGA,OAAO,MAAMC,WAAW,GACtBvB,MAAM,CAACwB,gBAAgB;AAEzB;;;;AAIA,OAAO,MAAMC,GAAG,GAWZzB,MAAM,CAAC0B,QAAQ","ignoreList":[]}
+{"version":3,"file":"Scope.js","names":["effect","TypeId","ScopeTypeId","CloseableTypeId","ScopeCloseableTypeId","Scope","scopeTag","make","scopeMake","makeUnsafe","scopeMakeUnsafe","provide","provideScope","addFinalizerExit","scopeAddFinalizerExit","addFinalizer","scopeAddFinalizer","fork","scopeFork","forkUnsafe","scopeForkUnsafe","close","scopeClose","closeUnsafe","scopeCloseUnsafe","use","scopeUse"],"sources":["../src/Scope.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;AAmBA,OAAO,KAAKA,MAAM,MAAM,sBAAsB;AAE9C,MAAMC,MAAM,GAAGD,MAAM,CAACE,WAAW;AACjC,MAAMC,eAAe,GAAGH,MAAM,CAACI,oBAAoB;AA+KnD;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAMC,KAAK,GAAkCL,MAAM,CAACM,QAAQ;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAMC,IAAI,GAAyEP,MAAM,CAACQ,SAAS;AAE1G;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAMC,UAAU,GAAiET,MAAM,CAACU,eAAe;AAE9G;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,OAAO,MAAMC,OAAO,GAuDhBX,MAAM,CAACY,YAAY;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCA,OAAO,MAAMC,gBAAgB,GAC3Bb,MAAM,CAACc,qBAAqB;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,OAAO,MAAMC,YAAY,GAA+Df,MAAM,CAACgB,iBAAiB;AAEhH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,OAAO,MAAMC,IAAI,GAGQjB,MAAM,CAACkB,SAAS;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,OAAO,MAAMC,UAAU,GACrBnB,MAAM,CAACoB,eAAe;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,OAAO,MAAMC,KAAK,GAA0DrB,MAAM,CAACsB,UAAU;AAE7F;;;;;;;;;;;AAWA,OAAO,MAAMC,WAAW,GACtBvB,MAAM,CAACwB,gBAAgB;AAEzB;;;;;;;;;;;AAWA,OAAO,MAAMC,GAAG,GAyBZzB,MAAM,CAAC0B,QAAQ","ignoreList":[]}