@manyducks.co/dolla 2.0.0-alpha.5 → 2.0.0-alpha.6

package/dist/signals.d.ts

@@ -1,101 +0,0 @@
-/**
- * Stops the observer that created it when called.
- */
-export type StopFunction = () => void;
-type Unwrapped<T> = T extends Signal<infer V> ? V : T;
-/**
- * Extracts value types from an array of signals.
- */
-export type SignalValues<T extends MaybeSignal<any>[]> = {
-    [K in keyof T]: Unwrapped<T[K]>;
-};
-export interface CreateSignalOptions<T> {
-    /**
-     * Determines if the `next` value is equal to the `current` value.
-     * If this function returns true, watchers will be notified of changes. If it returns false, watchers will not be notified.
-     * By default equality is defined as deep equality.
-     *
-     * @param next - The new value being set.
-     * @param current - The current value being replaced.
-     */
-    equality?: (next: T, current: T) => boolean;
-}
-export interface SignalWatchOptions<T> {
-    /**
-     * If true the watch callback will be called for the first time on the next change.
-     * By default the callback is called immediately with the signal's current value.
-     */
-    lazy?: boolean;
-}
-export interface Signal<T> {
-    /**
-     * Returns the current value.
-     */
-    get(): T;
-    /**
-     * Watch this signal's value with a `callback` function.
-     * The `callback` is only called if the value is not equal to the current value.
-     *
-     * > NOTE: If watching a signal inside a view, use the `.watch` method on the `ViewContext`. That method will automatically
-     * clean up all watchers when the view is disconnected. Watchers created here must be cleaned up manually.
-     */
-    watch(callback: (value: T) => void, options?: SignalWatchOptions<T>): StopFunction;
-}
-/** A new value for a signal, or a callback that receives the current value and returns a new one. */
-export type SignalSetAction<I, O = I> = O | ((current: I) => O);
-/** Callback that updates the value of a signal. */
-export type SignalSetter<I, O = I> = (value: SignalSetAction<I, O>) => void;
-export type MaybeSignal<T> = Signal<T> | T;
-/**
- * A signal and setter in one. Useful for passing signals that are intended to be updated by subviews.
- */
-export interface SettableSignal<I, O = I> extends Signal<I> {
-    /**
-     * Updates the signal's value.
-     */
-    set(next: O): void;
-    /**
-     * Takes a callback that recieves the signal's current value and returns a new one.
-     */
-    set(callback: (current: I) => O): void;
-}
-export declare function isSignal<T>(value: any): value is Signal<T>;
-export declare function isSettableSignal<T>(value: any): value is Signal<T>;
-/**
- * Retrieves a plain value from a variable that may be a signal.
- */
-export declare function designalify<T>(value: MaybeSignal<T>): T;
-/**
- * Ensures a variable that may be a signal or plain value is a signal.
- */
-export declare function signalify<T>(value: MaybeSignal<T>): Signal<T>;
-/**
- * Creates a SettableSignal.
- */
-export declare function createSettableSignal<T>(initialValue: T, options?: CreateSignalOptions<T>): SettableSignal<T>;
-/**
- * Creates a SettableSignal.
- */
-export declare function createSettableSignal<T>(initialValue?: T, options?: CreateSignalOptions<T | undefined>): SettableSignal<T | undefined>;
-/**
- * Join a signal and its setter into a single SettableSignal object.
- */
-export declare function toSettableSignal<I, O = I>(signal: Signal<I>, setter: SignalSetter<I, O>): SettableSignal<I, O>;
-/**
- * Creates a SignalSetter with custom logic provided by `callback`.
- */
-export declare function createSignalSetter<I, O = I>(signal: Signal<I>, callback: (next: O, current: I) => void): SignalSetter<I, O>;
-/**
- * Creates a signal and setter.
- */
-export declare function createSignal<T>(initialValue: T, options?: CreateSignalOptions<T>): [Signal<T>, SignalSetter<T>];
-/**
- * Creates a signal and setter.
- */
-export declare function createSignal<T>(initialValue?: T, options?: CreateSignalOptions<T | undefined>): [Signal<T | undefined>, SignalSetter<T | undefined>];
-export interface DeriveOptions {
-    equality?: (next: unknown, current: unknown) => boolean;
-}
-export declare function derive<Inputs extends MaybeSignal<any>[], T>(signals: [...Inputs], fn: (...currentValues: SignalValues<Inputs>) => T | Signal<T>, options?: DeriveOptions): Signal<T>;
-export declare function watch<I extends MaybeSignal<any>[]>(signals: [...I], fn: (...currentValues: SignalValues<I>) => void): StopFunction;
-export {};