effect/dist/dts/TSubscriptionRef.d.ts

The missing standard library for TypeScript, for writing production-grade software.

/**
 * @since 3.10.0
 */
import type * as Effect from "./Effect.js";
import type * as Option from "./Option.js";
import type * as Scope from "./Scope.js";
import type * as STM from "./STM.js";
import type * as Stream from "./Stream.js";
import type * as TQueue from "./TQueue.js";
import type * as TRef from "./TRef.js";
import type * as Types from "./Types.js";
/**
 * @since 3.10.0
 * @category symbols
 */
export declare const TSubscriptionRefTypeId: unique symbol;
/**
 * @since 3.10.0
 * @category symbols
 */
export type TSubscriptionRefTypeId = typeof TSubscriptionRefTypeId;
/**
 * A `TSubscriptionRef<A>` is a `TRef` that can be subscribed to in order to
 * receive a `TDequeue<A>` of the current value and all committed changes to the value.
 *
 * @since 3.10.0
 * @category models
 */
export interface TSubscriptionRef<in out A> extends TSubscriptionRef.Variance<A>, TRef.TRef<A> {
    /**
     * A TDequeue containing the current value of the `Ref` as well as all changes
     * to that value.
     */
    readonly changes: STM.STM<TQueue.TDequeue<A>>;
}
/**
 * @since 3.10.0
 */
export declare namespace TSubscriptionRef {
    /**
     * @since 3.10.0
     * @category models
     */
    interface Variance<in out A> {
        readonly [TSubscriptionRefTypeId]: {
            readonly _A: Types.Invariant<A>;
        };
    }
}
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const get: <A>(self: TSubscriptionRef<A>) => STM.STM<A>;
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const getAndSet: {
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(value: A): (self: TSubscriptionRef<A>) => STM.STM<A>;
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(self: TSubscriptionRef<A>, value: A): STM.STM<A>;
};
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const getAndUpdate: {
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(f: (a: A) => A): (self: TSubscriptionRef<A>) => STM.STM<A>;
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(self: TSubscriptionRef<A>, f: (a: A) => A): STM.STM<A>;
};
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const getAndUpdateSome: {
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(f: (a: A) => Option.Option<A>): (self: TSubscriptionRef<A>) => STM.STM<A>;
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(self: TSubscriptionRef<A>, f: (a: A) => Option.Option<A>): STM.STM<A>;
};
/**
 * @since 3.10.0
 * @category constructors
 */
export declare const make: <A>(value: A) => STM.STM<TSubscriptionRef<A>>;
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const modify: {
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A, B>(f: (a: A) => readonly [B, A]): (self: TSubscriptionRef<A>) => STM.STM<B>;
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A, B>(self: TSubscriptionRef<A>, f: (a: A) => readonly [B, A]): STM.STM<B>;
};
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const modifySome: {
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A, B>(fallback: B, f: (a: A) => Option.Option<readonly [B, A]>): (self: TSubscriptionRef<A>) => STM.STM<B>;
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A, B>(self: TSubscriptionRef<A>, fallback: B, f: (a: A) => Option.Option<readonly [B, A]>): STM.STM<B>;
};
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const set: {
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(value: A): (self: TSubscriptionRef<A>) => STM.STM<void>;
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(self: TSubscriptionRef<A>, value: A): STM.STM<void>;
};
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const setAndGet: {
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(value: A): (self: TSubscriptionRef<A>) => STM.STM<A>;
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(self: TSubscriptionRef<A>, value: A): STM.STM<A>;
};
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const update: {
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(f: (a: A) => A): (self: TSubscriptionRef<A>) => STM.STM<void>;
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(self: TSubscriptionRef<A>, f: (a: A) => A): STM.STM<void>;
};
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const updateAndGet: {
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(f: (a: A) => A): (self: TSubscriptionRef<A>) => STM.STM<A>;
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(self: TSubscriptionRef<A>, f: (a: A) => A): STM.STM<A>;
};
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const updateSome: {
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(f: (a: A) => Option.Option<A>): (self: TSubscriptionRef<A>) => STM.STM<void>;
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(self: TSubscriptionRef<A>, f: (a: A) => Option.Option<A>): STM.STM<void>;
};
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const updateSomeAndGet: {
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(f: (a: A) => Option.Option<A>): (self: TSubscriptionRef<A>) => STM.STM<A>;
    /**
     * @since 3.10.0
     * @category mutations
     */
    <A>(self: TSubscriptionRef<A>, f: (a: A) => Option.Option<A>): STM.STM<A>;
};
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const changesScoped: <A>(self: TSubscriptionRef<A>) => Effect.Effect<TQueue.TDequeue<A>, never, Scope.Scope>;
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const changesStream: <A>(self: TSubscriptionRef<A>) => Stream.Stream<A>;
/**
 * @since 3.10.0
 * @category mutations
 */
export declare const changes: <A>(self: TSubscriptionRef<A>) => STM.STM<TQueue.TDequeue<A>>;
//# sourceMappingURL=TSubscriptionRef.d.ts.map