import { type Ref } from 'vue';
import { type CancelablePromise } from '@nzyme/utils';
import { type RefParam } from './reactivity/makeRef.js';
export interface DataSourceLoader<TParams, TResult> {
    (params: TParams, oldValue: TResult | undefined): Promise<TResult> | CancelablePromise<TResult> | TResult;
}
export type DataSourceBehavior = 'lazy' | 'eager';
export interface DataSourceOptions<TParams, TResult, TDefault = undefined> {
    /**
     * Request payload - it will be watched for changes to make calls.
     * Can be function or a reference.
     * If undefined is returned, API call will not be made.
     */
    readonly params?: RefParam<TParams>;
    readonly load: DataSourceLoader<TParams, TResult>;
    readonly default?: RefParam<TDefault>;
    readonly behavior?: DataSourceBehavior;
    /** Options for debouncing */
    readonly debounce?: {
        /** Number of milliseconds to debounce api calls */
        time?: number;
        leading?: boolean;
        trailing?: boolean;
    };
    /** Data will be loaded into this ref. Optional. */
    readonly data?: ((result: TResult) => void) | Ref<TResult | undefined>;
    readonly onLoad?: (result: TResult, params: TParams) => unknown;
}
export interface DataSource<TResult, TDefault extends TResult | undefined = undefined> extends Ref<TResult | TDefault> {
    readonly pending: Promise<TResult> | null;
    readonly get: () => Promise<TResult>;
    readonly reload: () => Promise<TResult>;
    readonly clear: () => void;
    readonly invalidate: () => void;
}
export declare function useDataSource<TParams, TResult, TDefault extends TResult | undefined = undefined>(opts: DataSourceOptions<TParams, TResult, TDefault>): DataSource<TResult, TDefault>;