/** * @since 2.0.0 */ import type * as Effect from "./Effect.js"; import type { LazyArg } from "./Function.js"; import type { Pipeable } from "./Pipeable.js"; import type * as Scope from "./Scope.js"; import type * as Types from "./Types.js"; import type * as Unify from "./Unify.js"; /** * @since 2.0.0 * @category symbols */ export declare const ScopedRefTypeId: unique symbol; /** * @since 2.0.0 * @category symbols */ export type ScopedRefTypeId = typeof ScopedRefTypeId; /** * A `ScopedRef` is a reference whose value is associated with resources, * which must be released properly. You can both get the current value of any * `ScopedRef`, as well as set it to a new value (which may require new * resources). The reference itself takes care of properly releasing resources * for the old value whenever a new value is obtained. * * @since 2.0.0 * @category models */ export interface ScopedRef extends Effect.Effect, ScopedRef.Variance, Pipeable { readonly [Unify.typeSymbol]?: unknown; readonly [Unify.unifySymbol]?: ScopedRefUnify; readonly [Unify.ignoreSymbol]?: ScopedRefUnifyIgnore; } /** * @category models * @since 3.9.0 */ export interface ScopedRefUnify extends Effect.EffectUnify { ScopedRef?: () => Extract>; } /** * @category models * @since 3.9.0 */ export interface ScopedRefUnifyIgnore extends Effect.EffectUnifyIgnore { Effect?: true; } /** * @since 2.0.0 */ export declare namespace ScopedRef { /** * @since 2.0.0 * @category models */ interface Variance { readonly [ScopedRefTypeId]: { readonly _A: Types.Invariant; }; } } /** * Creates a new `ScopedRef` from an effect that resourcefully produces a * value. * * @since 2.0.0 * @category constructors */ export declare const fromAcquire: (acquire: Effect.Effect) => Effect.Effect, E, Scope.Scope | R>; /** * Retrieves the current value of the scoped reference. * * @since 2.0.0 * @category getters */ export declare const get: (self: ScopedRef) => Effect.Effect; /** * Creates a new `ScopedRef` from the specified value. This method should * not be used for values whose creation require the acquisition of resources. * * @since 2.0.0 * @category constructors */ export declare const make: (evaluate: LazyArg) => Effect.Effect, never, Scope.Scope>; /** * Sets the value of this reference to the specified resourcefully-created * value. Any resources associated with the old value will be released. * * This method will not return until either the reference is successfully * changed to the new value, with old resources released, or until the attempt * to acquire a new value fails. * * @since 2.0.0 * @category getters */ export declare const set: { /** * Sets the value of this reference to the specified resourcefully-created * value. Any resources associated with the old value will be released. * * This method will not return until either the reference is successfully * changed to the new value, with old resources released, or until the attempt * to acquire a new value fails. * * @since 2.0.0 * @category getters */ (acquire: Effect.Effect): (self: ScopedRef) => Effect.Effect>; /** * Sets the value of this reference to the specified resourcefully-created * value. Any resources associated with the old value will be released. * * This method will not return until either the reference is successfully * changed to the new value, with old resources released, or until the attempt * to acquire a new value fails. * * @since 2.0.0 * @category getters */ (self: ScopedRef, acquire: Effect.Effect): Effect.Effect>; }; //# sourceMappingURL=ScopedRef.d.ts.map