@uwdata/mosaic-core/dist/src/Param.d.ts

Scalable and extensible linked data views.

import { AsyncDispatch } from './util/AsyncDispatch.js';
/**
 * Test if a value is a Param instance.
 * @param x The value to test.
 * @returns True if the input is a Param, false otherwise.
 */
export declare function isParam<T>(x: unknown): x is Param<T>;
/**
 * Represents a dynamic parameter that dispatches updates
 * upon parameter changes.
 */
export declare class Param<T> extends AsyncDispatch<T> {
    protected _value?: T;
    /**
     * Create a new Param instance.
     * @param value The initial value of the Param.
     */
    constructor(value?: T);
    /**
     * Create a new Param instance with the given initial value.
     * @param value The initial value of the Param.
     * @returns The new Param instance.
     */
    static value<T>(value: T): Param<T>;
    /**
     * Create a new Param instance over an array of initial values,
     * which may contain nested Params.
     * @param values The initial values of the Param.
     * @returns The new Param instance.
     */
    static array<T>(values: (T | Param<T>)[]): Param<T[]>;
    /**
     * The current value of the Param.
     */
    get value(): T | undefined;
    /**
     * Update the Param value
     * @param value The new value of the Param.
     * @param options The update options.
     * @param options.force A boolean flag indicating if the Param
     *  should emit a 'value' event even if the internal value is unchanged.
     * @returns This Param instance.
     */
    update(value: T, { force }?: {
        force?: boolean;
    }): this;
    /**
     * Upon value-typed updates, sets the current value to the input value
     * immediately prior to the event value being emitted to listeners.
     * @param type The event type.
     * @param value The input event value.
     * @returns The input event value.
     */
    willEmit(type: string, value: T): T;
}
//# sourceMappingURL=Param.d.ts.map