import type { AnyFunction, CancelableFunction } from 'tachyon-type-library';
import type { RequireAtLeastOne } from 'type-fest';
export type ThrottleOptions = RequireAtLeastOne<{
    leading: true;
    trailing: true;
}, 'leading' | 'trailing'>;
export type DebounceOptions = ThrottleOptions & {
    maxWait?: number;
};
interface DebouncedFunc<Fn extends AnyFunction> extends CancelableFunction {
    (...args: Parameters<Fn>): ReturnType<Fn>;
}
export type Debounce = <Fn extends AnyFunction>(func: Fn, wait: number, options: DebounceOptions) => DebouncedFunc<Fn>;
/**
 * Creates a debounced function that delays invoking `func` until after `wait`
 * milliseconds have elapsed since the last time the debounced function was
 * invoked, or until the next browser frame is drawn. The debounced function
 * comes with a `cancel` method to cancel delayed `func` invocations. Provide
 * `options` to indicate whether `func` should be invoked on the leading
 * and/or trailing edge of the`wait` timeout. The `func` is invoked with the
 * last arguments provided to the debounced function. Subsequent calls to the
 * debounced function return the result of the last `func` invocation.
 *
 * **Note:** If `leading` and `trailing` options are `true`, `func` is
 * invoked on the trailing edge of the timeout only if the debounced function
 * is invoked more than once during the `wait` timeout.
 *
 * If `wait` is `0` and `leading` is `false`, `func` invocation is deferred
 * until the next tick, similar to `setTimeout` with a timeout of `0`.
 *
 * If `wait` is omitted in an environment with `requestAnimationFrame`, `func`
 * invocation will be deferred until the next frame is drawn (typically about
 * 16ms).
 *
 * See [David Corbacho's article](https://css-tricks.com/debouncing-throttling-explained-examples/)
 * for details over the differences between `debounce` and `throttle`.
 *
 * @param {Function} func The function to debounce.
 * @param {number} [wait=0]
 *  The number of milliseconds to delay
 * @param {Object} [options={}] The options object.
 * @param {boolean} [options.leading=false]
 *  Specify invoking on the leading edge of the timeout.
 * @param {number} [options.maxWait]
 *  The maximum time `func` is allowed to be delayed before it's invoked.
 * @param {boolean} [options.trailing=true]
 *  Specify invoking on the trailing edge of the timeout.
 * @returns {Function} Returns the new debounced function.
 */
export declare function debounce<Fn extends AnyFunction>(func: Fn, wait: number, options: DebounceOptions): DebouncedFunc<Fn>;
/**
 * Creates a throttled function that only invokes `func` at most once
 * per every `wait` milliseconds. See debounce for a detailed explanation.
 */
export declare const throttle: Debounce;
export {};
//# sourceMappingURL=index.d.ts.map