veffect
Version:
powerful TypeScript validation library built on the robust foundation of Effect combining exceptional type safety, high performance, and developer experience. Taking inspiration from Effect's functional principles, VEffect delivers a balanced approach tha
83 lines • 2.63 kB
TypeScript
/**
* @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";
/**
* @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 ScopedRef.Variance<A>, Pipeable {
}
/**
* @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: {
<A, R, E>(acquire: Effect.Effect<A, E, R>): (self: ScopedRef<A>) => Effect.Effect<void, E, Exclude<R, Scope.Scope>>;
<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