effect 2.0.0-next.37 → 2.0.0-next.38

package/dist/declarations/src/Layer.d.ts

@@ -15,7 +15,7 @@
  * Because of their excellent composition properties, layers are the idiomatic
  * way in Effect-TS to create services that depend on other services.
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 import type * as Cause from "./Cause.js";
 import * as Context from "./Context.js";
@@ -27,27 +27,27 @@ import type * as Runtime from "./Runtime.js";
 import type * as Schedule from "./Schedule.js";
 import type * as Scope from "./Scope.js";
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category symbols
  */
 export declare const LayerTypeId: unique symbol;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category symbols
  */
 export type LayerTypeId = typeof LayerTypeId;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category models
  */
 export interface Layer<RIn, E, ROut> extends Layer.Variance<RIn, E, ROut>, Pipeable {
 }
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare namespace Layer {
     /**
-     * @since 1.0.0
+     * @since 2.0.0
      * @category models
      */
     interface Variance<RIn, E, ROut> {
@@ -58,17 +58,17 @@ export declare namespace Layer {
         };
     }
     /**
-     * @since 1.0.0
+     * @since 2.0.0
      * @category type-level
      */
     type Context<T extends Layer<any, any, never>> = [T] extends [Layer<infer _R, infer _E, infer _A>] ? _R : never;
     /**
-     * @since 1.0.0
+     * @since 2.0.0
      * @category type-level
      */
     type Error<T extends Layer<any, any, never>> = [T] extends [Layer<infer _R, infer _E, infer _A>] ? _E : never;
     /**
-     * @since 1.0.0
+     * @since 2.0.0
      * @category type-level
      */
     type Success<T extends Layer<any, any, never>> = [T] extends [Layer<infer _R, infer _E, infer _A>] ? _A : never;
@@ -76,7 +76,7 @@ export declare namespace Layer {
 /**
  * Returns `true` if the specified value is a `Layer`, `false` otherwise.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category getters
  */
 export declare const isLayer: (u: unknown) => u is Layer<unknown, unknown, unknown>;
@@ -84,14 +84,14 @@ export declare const isLayer: (u: unknown) => u is Layer<unknown, unknown, unkno
  * Returns `true` if the specified `Layer` is a fresh version that will not be
  * shared, `false` otherwise.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category getters
  */
 export declare const isFresh: <R, E, A>(self: Layer<R, E, A>) => boolean;
 /**
  * Builds a layer into a scoped value.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category destructors
  */
 export declare const build: <RIn, E, ROut>(self: Layer<RIn, E, ROut>) => Effect.Effect<Scope.Scope | RIn, E, Context.Context<ROut>>;
@@ -102,7 +102,7 @@ export declare const build: <RIn, E, ROut>(self: Layer<RIn, E, ROut>) => Effect.
  * the services output by the layer exceed the lifetime of the effect the
  * layer is provided to.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category destructors
  */
 export declare const buildWithScope: {
@@ -112,7 +112,7 @@ export declare const buildWithScope: {
 /**
  * Recovers from all errors.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category error handling
  */
 export declare const catchAll: {
@@ -122,7 +122,7 @@ export declare const catchAll: {
 /**
  * Recovers from all errors.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category error handling
  */
 export declare const catchAllCause: {
@@ -133,21 +133,21 @@ export declare const catchAllCause: {
  * Constructs a `Layer` that passes along the specified context as an
  * output.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const context: <R>() => Layer<R, never, R>;
 /**
  * Constructs a layer that dies with the specified defect.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const die: (defect: unknown) => Layer<never, never, unknown>;
 /**
  * Constructs a layer that dies with the specified defect.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const dieSync: (evaluate: LazyArg<unknown>) => Layer<never, never, unknown>;
@@ -155,14 +155,14 @@ export declare const dieSync: (evaluate: LazyArg<unknown>) => Layer<never, never
  * Replaces the layer's output with `void` and includes the layer only for its
  * side-effects.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category mapping
  */
 export declare const discard: <RIn, E, ROut>(self: Layer<RIn, E, ROut>) => Layer<RIn, E, never>;
 /**
  * Constructs a layer from the specified effect.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const effect: {
@@ -172,7 +172,7 @@ export declare const effect: {
 /**
  * Constructs a layer from the specified effect discarding it's output.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const effectDiscard: <R, E, _>(effect: Effect.Effect<R, E, _>) => Layer<R, E, never>;
@@ -180,7 +180,7 @@ export declare const effectDiscard: <R, E, _>(effect: Effect.Effect<R, E, _>) =>
  * Constructs a layer from the specified effect, which must return one or more
  * services.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const effectContext: <R, E, A>(effect: Effect.Effect<R, E, Context.Context<A>>) => Layer<R, E, A>;
@@ -190,42 +190,42 @@ export declare const effectContext: <R, E, A>(effect: Effect.Effect<R, E, Contex
  * that effect completes execution but instead when the scope the resulting
  * effect depends on is closed.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const extendScope: <RIn, E, ROut>(self: Layer<RIn, E, ROut>) => Layer<Scope.Scope | RIn, E, ROut>;
 /**
  * Constructs a layer that fails with the specified error.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const fail: <E>(error: E) => Layer<never, E, unknown>;
 /**
  * Constructs a layer that fails with the specified error.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const failSync: <E>(evaluate: LazyArg<E>) => Layer<never, E, unknown>;
 /**
  * Constructs a layer that fails with the specified cause.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const failCause: <E>(cause: Cause.Cause<E>) => Layer<never, E, unknown>;
 /**
  * Constructs a layer that fails with the specified cause.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const failCauseSync: <E>(evaluate: LazyArg<Cause.Cause<E>>) => Layer<never, E, unknown>;
 /**
  * Constructs a layer dynamically based on the output of this layer.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category sequencing
  */
 export declare const flatMap: {
@@ -235,7 +235,7 @@ export declare const flatMap: {
 /**
  * Flattens layers nested in the context of an effect.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category sequencing
  */
 export declare const flatten: {
@@ -245,7 +245,7 @@ export declare const flatten: {
 /**
  * Creates a fresh version of this layer that will not be shared.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const fresh: <R, E, A>(self: Layer<R, E, A>) => Layer<R, E, A>;
@@ -254,7 +254,7 @@ export {
 /**
  * Constructs a layer from the context using the specified function.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 fromFunction as function };
@@ -262,14 +262,14 @@ fromFunction as function };
  * 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.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category conversions
  */
 export declare const launch: <RIn, E, ROut>(self: Layer<RIn, E, ROut>) => Effect.Effect<RIn, E, never>;
 /**
  * Returns a new layer whose output is mapped by the specified function.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category mapping
  */
 export declare const map: {
@@ -279,7 +279,7 @@ export declare const map: {
 /**
  * Returns a layer with its error channel mapped using the specified function.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category mapping
  */
 export declare const mapError: {
@@ -291,7 +291,7 @@ export declare const mapError: {
  * the specified `failure` or `success` layers, resulting in a new layer with
  * the inputs of this layer, and the error or outputs of the specified layer.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category folding
  */
 export declare const match: {
@@ -309,7 +309,7 @@ export declare const match: {
  * the specified `failure` or `success` layers, resulting in a new layer with
  * the inputs of this layer, and the error or outputs of the specified layer.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category folding
  */
 export declare const matchCause: {
@@ -326,7 +326,7 @@ export declare const matchCause: {
  * Returns a scoped effect that, if evaluated, will return the lazily computed
  * result of this layer.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const memoize: <RIn, E, ROut>(self: Layer<RIn, E, ROut>) => Effect.Effect<Scope.Scope, never, Layer<RIn, E, ROut>>;
@@ -334,7 +334,7 @@ export declare const memoize: <RIn, E, ROut>(self: Layer<RIn, E, ROut>) => Effec
  * Combines this layer with the specified layer, producing a new layer that
  * has the inputs and outputs of both.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const merge: {
@@ -344,7 +344,7 @@ export declare const merge: {
 /**
  * Merges all the layers together in parallel.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category zipping
  */
 export declare const mergeAll: <Layers extends [Layer<any, any, never>, ...Array<Layer<any, any, never>>]>(...layers: Layers) => Layer<{
@@ -358,7 +358,7 @@ export declare const mergeAll: <Layers extends [Layer<any, any, never>, ...Array
  * Translates effect failure into death of the fiber, making all failures
  * unchecked and not a part of the type of the layer.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category error handling
  */
 export declare const orDie: <R, E, A>(self: Layer<R, E, A>) => Layer<R, never, A>;
@@ -366,7 +366,7 @@ export declare const orDie: <R, E, A>(self: Layer<R, E, A>) => Layer<R, never, A
  * Executes this layer and returns its output, if it succeeds, but otherwise
  * executes the specified layer.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category error handling
  */
 export declare const orElse: {
@@ -377,7 +377,7 @@ export declare const orElse: {
  * Returns a new layer that produces the outputs of this layer but also
  * passes through the inputs.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const passthrough: <RIn, E, ROut>(self: Layer<RIn, E, ROut>) => Layer<RIn, E, RIn | ROut>;
@@ -385,7 +385,7 @@ export declare const passthrough: <RIn, E, ROut>(self: Layer<RIn, E, ROut>) => L
  * Projects out part of one of the services output by this layer using the
  * specified function.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const project: {
@@ -397,7 +397,7 @@ export declare const project: {
  * 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.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const provide: {
@@ -405,7 +405,7 @@ export declare const provide: {
     <RIn, E, ROut, RIn2, E2, ROut2>(self: Layer<RIn, E, ROut>, that: Layer<RIn2, E2, ROut2>): Layer<RIn | Exclude<RIn2, ROut>, E | E2, ROut2>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const locallyEffect: {
@@ -413,7 +413,7 @@ export declare const locallyEffect: {
     <RIn, E, ROut, RIn2, E2, ROut2>(self: Layer<RIn, E, ROut>, f: (_: Effect.Effect<RIn, E, Context.Context<ROut>>) => Effect.Effect<RIn2, E2, Context.Context<ROut2>>): Layer<RIn2, E2, ROut2>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const locally: {
@@ -421,7 +421,7 @@ export declare const locally: {
     <R, E, A, X>(self: Layer<R, E, A>, ref: FiberRef<X>, value: X): Layer<R, E, A>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const locallyWith: {
@@ -429,12 +429,12 @@ export declare const locallyWith: {
     <R, E, A, X>(self: Layer<R, E, A>, ref: FiberRef<X>, value: (_: X) => X): Layer<R, E, A>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const locallyScoped: <A>(self: FiberRef<A>, value: A) => Layer<never, never, never>;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const fiberRefLocallyScopedWith: <A>(self: FiberRef<A>, value: (_: A) => A) => Layer<never, never, never>;
@@ -443,7 +443,7 @@ export declare const fiberRefLocallyScopedWith: <A>(self: FiberRef<A>, value: (_
  * layer, resulting in a new layer with the inputs of this layer, and the
  * outputs of both layers.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const provideMerge: {
@@ -453,7 +453,7 @@ export declare const provideMerge: {
 /**
  * Retries constructing this layer according to the specified schedule.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category retrying
  */
 export declare const retry: {
@@ -466,14 +466,14 @@ export declare const retry: {
  * interruption. This can be used to close a scope when providing a layer to a
  * workflow.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const scope: Layer<never, never, Scope.CloseableScope>;
 /**
  * Constructs a layer from the specified scoped effect.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const scoped: {
@@ -483,7 +483,7 @@ export declare const scoped: {
 /**
  * Constructs a layer from the specified scoped effect.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const scopedDiscard: <R, E, T>(effect: Effect.Effect<R, E, T>) => Layer<Exclude<R, Scope.Scope>, E, never>;
@@ -491,7 +491,7 @@ export declare const scopedDiscard: <R, E, T>(effect: Effect.Effect<R, E, T>) =>
  * Constructs a layer from the specified scoped effect, which must return one
  * or more services.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const scopedContext: <R, E, A>(effect: Effect.Effect<R, E, Context.Context<A>>) => Layer<Exclude<R, Scope.Scope>, E, A>;
@@ -499,14 +499,14 @@ export declare const scopedContext: <R, E, A>(effect: Effect.Effect<R, E, Contex
  * Constructs a layer that accesses and returns the specified service from the
  * context.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const service: <T extends Context.Tag<any, any>>(tag: T) => Layer<Context.Tag.Identifier<T>, never, Context.Tag.Identifier<T>>;
 /**
  * Constructs a layer from the specified value.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const succeed: {
@@ -517,7 +517,7 @@ export declare const succeed: {
  * Constructs a layer from the specified value, which must return one or more
  * services.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const succeedContext: <A>(context: Context.Context<A>) => Layer<never, never, A>;
@@ -525,14 +525,14 @@ export declare const succeedContext: <A>(context: Context.Context<A>) => Layer<n
  * Lazily constructs a layer. This is useful to avoid infinite recursion when
  * creating layers that refer to themselves.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const suspend: <RIn, E, ROut>(evaluate: LazyArg<Layer<RIn, E, ROut>>) => Layer<RIn, E, ROut>;
 /**
  * Lazily constructs a layer from the specified value.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const sync: {
@@ -543,14 +543,14 @@ export declare const sync: {
  * Lazily constructs a layer from the specified value, which must return one or more
  * services.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category constructors
  */
 export declare const syncContext: <A>(evaluate: LazyArg<Context.Context<A>>) => Layer<never, never, A>;
 /**
  * Performs the specified effect if this layer succeeds.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category sequencing
  */
 export declare const tap: {
@@ -560,7 +560,7 @@ export declare const tap: {
 /**
  * Performs the specified effect if this layer fails.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category sequencing
  */
 export declare const tapError: {
@@ -570,7 +570,7 @@ export declare const tapError: {
 /**
  * Performs the specified effect if this layer fails.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category sequencing
  */
 export declare const tapErrorCause: {
@@ -581,7 +581,7 @@ export declare const tapErrorCause: {
  * Converts a layer that requires no services into a scoped runtime, which can
  * be used to execute effects.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category conversions
  */
 export declare const toRuntime: <RIn, E, ROut>(self: Layer<RIn, E, ROut>) => Effect.Effect<Scope.Scope | RIn, E, Runtime.Runtime<ROut>>;
@@ -590,7 +590,7 @@ export declare const toRuntime: <RIn, E, ROut>(self: Layer<RIn, E, ROut>) => Eff
  * 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.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const use: {
@@ -602,7 +602,7 @@ export declare const use: {
  * layer, resulting in a new layer with the inputs of this layer, and the
  * outputs of both layers.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const useMerge: {
@@ -614,7 +614,7 @@ export declare const useMerge: {
  * inputs of both, and the outputs of both combined using the specified
  * function.
  *
- * @since 1.0.0
+ * @since 2.0.0
  * @category zipping
  */
 export declare const zipWithPar: {
@@ -622,12 +622,12 @@ export declare const zipWithPar: {
     <R, E, R2, E2, B, A, C>(self: Layer<R, E, A>, that: Layer<R2, E2, B>, f: (a: Context.Context<A>, b: Context.Context<B>) => Context.Context<C>): Layer<R | R2, E | E2, C>;
 };
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const unwrapEffect: <R, E, R1, E1, A>(self: Effect.Effect<R, E, Layer<R1, E1, A>>) => Layer<R | R1, E | E1, A>;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  * @category utils
  */
 export declare const unwrapScoped: <R, E, R1, E1, A>(self: Effect.Effect<R, E, Layer<R1, E1, A>>) => Layer<R1 | Exclude<R, Scope.Scope>, E | E1, A>;