MAINHACK

Viewing / Editing File: ScopedRef.d.ts

/**
 * @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<in out A> extends Effect.Effect<A>, ScopedRef.Variance<A>, Pipeable {
    readonly [Unify.typeSymbol]?: unknown;
    readonly [Unify.unifySymbol]?: ScopedRefUnify<this>;
    readonly [Unify.ignoreSymbol]?: ScopedRefUnifyIgnore;
}
/**
 * @category models
 * @since 3.9.0
 */
export interface ScopedRefUnify<A extends {
    [Unify.typeSymbol]?: any;
}> extends Effect.EffectUnify<A> {
    ScopedRef?: () => Extract<A[Unify.typeSymbol], ScopedRef<any>>;
}
/**
 * @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<in out A> {
        readonly [ScopedRefTypeId]: {
            readonly _A: Types.Invariant<A>;
        };
    }
}
/**
 * Creates a new `ScopedRef` from an effect that resourcefully produces a
 * value.
 *
 * @since 2.0.0
 * @category constructors
 */
export declare const fromAcquire: <A, E, R>(acquire: Effect.Effect<A, E, R>) => Effect.Effect<ScopedRef<A>, E, Scope.Scope | R>;
/**
 * Retrieves the current value of the scoped reference.
 *
 * @since 2.0.0
 * @category getters
 */
export declare const get: <A>(self: ScopedRef<A>) => Effect.Effect<A>;
/**
 * 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: <A>(evaluate: LazyArg<A>) => Effect.Effect<ScopedRef<A>, 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
     */
    <A, R, E>(acquire: Effect.Effect<A, E, R>): (self: ScopedRef<A>) => Effect.Effect<void, E, Exclude<R, 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
     */
    <A, R, E>(self: ScopedRef<A>, acquire: Effect.Effect<A, E, R>): Effect.Effect<void, E, Exclude<R, Scope.Scope>>;
};
//# sourceMappingURL=ScopedRef.d.ts.map

Cancel / Back

[ MAINHACK ]

Viewing / Editing File: ScopedRef.d.ts

Server Info

System Features

User Info