@zeix/cause-effect/src/computed.d.ts

Cause & Effect - reactive state management with signals.

type Computed<T extends {}> = {
    [Symbol.toStringTag]: 'Computed';
    get(): T;
};
type ComputedCallback<T extends {} & {
    then?: void;
}> = ((abort: AbortSignal) => Promise<T>) | (() => T);
declare const TYPE_COMPUTED = "Computed";
/**
 * Create a derived signal from existing signals
 *
 * @since 0.9.0
 * @param {ComputedCallback<T>} fn - computation callback function
 * @returns {Computed<T>} - Computed signal
 */
declare const computed: <T extends {}>(fn: ComputedCallback<T>) => Computed<T>;
/**
 * Check if a value is a computed state
 *
 * @since 0.9.0
 * @param {unknown} value - value to check
 * @returns {boolean} - true if value is a computed state, false otherwise
 */
declare const isComputed: <T extends {}>(value: unknown) => value is Computed<T>;
/**
 * Check if the provided value is a callback that may be used as input for toSignal() to derive a computed state
 *
 * @since 0.12.0
 * @param {unknown} value - value to check
 * @returns {boolean} - true if value is a callback or callbacks object, false otherwise
 */
declare const isComputedCallback: <T extends {}>(value: unknown) => value is ComputedCallback<T>;
export { type Computed, type ComputedCallback, TYPE_COMPUTED, computed, isComputed, isComputedCallback, };