@tanstack/pacer 0.16.3 → 0.16.4

package/dist/debouncer.cjs

@@ -0,0 +1,197 @@
+const require_utils = require('./utils.cjs');
+const require_event_client = require('./event-client.cjs');
+let __tanstack_store = require("@tanstack/store");
+
+//#region src/debouncer.ts
+function getDefaultDebouncerState() {
+	return {
+		canLeadingExecute: true,
+		executionCount: 0,
+		isPending: false,
+		lastArgs: void 0,
+		status: "idle",
+		maybeExecuteCount: 0
+	};
+}
+/**
+* Utility function for sharing common `DebouncerOptions` options between different `Debouncer` instances.
+*/
+function debouncerOptions(options) {
+	return options;
+}
+const defaultOptions = {
+	enabled: true,
+	leading: false,
+	trailing: true,
+	wait: 0
+};
+/**
+* A class that creates a debounced function.
+*
+* Debouncing ensures that a function is only executed after a certain amount of time has passed
+* since its last invocation. This is useful for handling frequent events like window resizing,
+* scroll events, or input changes where you want to limit the rate of execution.
+* This synchronous version is lighter weight and often all you need - upgrade to AsyncDebouncer when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+*
+* The debounced function can be configured to execute either at the start of the delay period
+* (leading edge) or at the end (trailing edge, default). Each new call during the wait period
+* will reset the timer.
+*
+* State Management:
+* - Uses TanStack Store for reactive state management
+* - Use `initialState` to provide initial state values when creating the debouncer
+* - Use `onExecute` callback to react to function execution and implement custom logic
+* - The state includes canLeadingExecute, execution count, and isPending status
+* - State can be accessed via `debouncer.store.state` when using the class directly
+* - When using framework adapters (React/Solid), state is accessed from `debouncer.state`
+*
+* @example
+* ```ts
+* const debouncer = new Debouncer((value: string) => {
+*   saveToDatabase(value);
+* }, { wait: 500 });
+*
+* // Will only save after 500ms of no new input
+* inputElement.addEventListener('input', () => {
+*   debouncer.maybeExecute(inputElement.value);
+* });
+* ```
+*/
+var Debouncer = class {
+	#timeoutId;
+	constructor(fn, initialOptions) {
+		this.fn = fn;
+		this.store = new __tanstack_store.Store(getDefaultDebouncerState());
+		this.setOptions = (newOptions) => {
+			this.options = {
+				...this.options,
+				...newOptions
+			};
+			if (!this.#getEnabled()) this.cancel();
+		};
+		this.maybeExecute = (...args) => {
+			if (!this.#getEnabled()) return void 0;
+			this.#setState({ maybeExecuteCount: this.store.state.maybeExecuteCount + 1 });
+			let _didLeadingExecute = false;
+			if (this.options.leading && this.store.state.canLeadingExecute) {
+				this.#setState({ canLeadingExecute: false });
+				_didLeadingExecute = true;
+				this.#execute(...args);
+			}
+			if (this.options.trailing) this.#setState({
+				isPending: true,
+				lastArgs: args
+			});
+			if (this.#timeoutId) clearTimeout(this.#timeoutId);
+			this.#timeoutId = setTimeout(() => {
+				this.#setState({ canLeadingExecute: true });
+				if (this.options.trailing && !_didLeadingExecute) this.#execute(...args);
+			}, this.#getWait());
+		};
+		this.flush = () => {
+			if (this.store.state.isPending && this.store.state.lastArgs) {
+				this.#clearTimeout();
+				this.#execute(...this.store.state.lastArgs);
+			}
+		};
+		this.cancel = () => {
+			this.#clearTimeout();
+			this.#setState({
+				canLeadingExecute: true,
+				isPending: false
+			});
+		};
+		this.reset = () => {
+			this.#setState(getDefaultDebouncerState());
+		};
+		this.key = initialOptions.key;
+		this.options = {
+			...defaultOptions,
+			...initialOptions
+		};
+		this.#setState(this.options.initialState ?? {});
+		if (this.key) require_event_client.pacerEventClient.on("d-Debouncer", (event) => {
+			if (event.payload.key !== this.key) return;
+			this.#setState(event.payload.store.state);
+			this.setOptions(event.payload.options);
+		});
+	}
+	#setState = (newState) => {
+		this.store.setState((state) => {
+			const combinedState = {
+				...state,
+				...newState
+			};
+			const { isPending } = combinedState;
+			return {
+				...combinedState,
+				status: !this.#getEnabled() ? "disabled" : isPending ? "pending" : "idle"
+			};
+		});
+		require_event_client.emitChange("Debouncer", this);
+	};
+	/**
+	* Returns the current enabled state of the debouncer
+	*/
+	#getEnabled = () => {
+		return !!require_utils.parseFunctionOrValue(this.options.enabled, this);
+	};
+	/**
+	* Returns the current wait time in milliseconds
+	*/
+	#getWait = () => {
+		return require_utils.parseFunctionOrValue(this.options.wait, this);
+	};
+	#execute = (...args) => {
+		if (!this.#getEnabled()) return void 0;
+		this.fn(...args);
+		this.#setState({
+			executionCount: this.store.state.executionCount + 1,
+			isPending: false,
+			lastArgs: void 0
+		});
+		this.options.onExecute?.(args, this);
+	};
+	#clearTimeout = () => {
+		if (this.#timeoutId) {
+			clearTimeout(this.#timeoutId);
+			this.#timeoutId = void 0;
+		}
+	};
+};
+/**
+* Creates a debounced function that delays invoking the provided function until after a specified wait time.
+* Multiple calls during the wait period will cancel previous pending invocations and reset the timer.
+*
+* This synchronous version is lighter weight and often all you need - upgrade to asyncDebounce when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+*
+* If leading option is true, the function will execute immediately on the first call, then wait the delay
+* before allowing another execution.
+*
+* State Management:
+* - Uses TanStack Store for reactive state management
+* - Use `initialState` to provide initial state values when creating the debouncer
+* - Use `onExecute` callback to react to function execution and implement custom logic
+* - The state includes canLeadingExecute, execution count, and isPending status
+* - State can be accessed via the underlying Debouncer instance's `store.state` property
+* - When using framework adapters (React/Solid), state is accessed from the hook's state property
+*
+* @example
+* ```ts
+* const debounced = debounce(() => {
+*   saveChanges();
+* }, { wait: 1000 });
+*
+* // Called repeatedly but executes at most once per second
+* inputElement.addEventListener('input', debounced);
+* ```
+*/
+function debounce(fn, initialOptions) {
+	return new Debouncer(fn, initialOptions).maybeExecute;
+}
+
+//#endregion
+exports.Debouncer = Debouncer;
+exports.debounce = debounce;
+exports.debouncerOptions = debouncerOptions;
+//# sourceMappingURL=debouncer.cjs.map

package/dist/debouncer.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"debouncer.cjs","names":["defaultOptions: Omit<\n  Required<DebouncerOptions<any>>,\n  'initialState' | 'onExecute' | 'key'\n>","fn: TFn","Store","#getEnabled","#setState","#execute","#timeoutId","#getWait","#clearTimeout","parseFunctionOrValue"],"sources":["../src/debouncer.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\nimport type { AnyFunction } from './types'\n\nexport interface DebouncerState<TFn extends AnyFunction> {\n  /**\n   * Whether the debouncer can execute on the leading edge of the timeout\n   */\n  canLeadingExecute: boolean\n  /**\n   * Number of function executions that have been completed\n   */\n  executionCount: number\n  /**\n   * Whether the debouncer is waiting for the timeout to trigger execution\n   */\n  isPending: boolean\n  /**\n   * The arguments from the most recent call to maybeExecute\n   */\n  lastArgs: Parameters<TFn> | undefined\n  /**\n   * Number of times maybeExecute has been called (for reduction calculations)\n   */\n  maybeExecuteCount: number\n  /**\n   * Current execution status - 'idle' when not active, 'pending' when waiting for timeout\n   */\n  status: 'disabled' | 'idle' | 'pending'\n}\n\nfunction getDefaultDebouncerState<\n  TFn extends AnyFunction,\n>(): DebouncerState<TFn> {\n  return {\n    canLeadingExecute: true,\n    executionCount: 0,\n    isPending: false,\n    lastArgs: undefined,\n    status: 'idle',\n    maybeExecuteCount: 0,\n  }\n}\n\n/**\n * Options for configuring a debounced function\n */\nexport interface DebouncerOptions<TFn extends AnyFunction> {\n  /**\n   * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Can be a boolean or a function that returns a boolean.\n   * Defaults to true.\n   */\n  enabled?: boolean | ((debouncer: Debouncer<TFn>) => boolean)\n  /**\n   * Initial state for the debouncer\n   */\n  initialState?: Partial<DebouncerState<TFn>>\n  /**\n   * A key to identify the debouncer.\n   * If provided, the debouncer will be identified by this key in the devtools and PacerProvider if applicable.\n   */\n  key?: string\n  /**\n   * Whether to execute on the leading edge of the timeout.\n   * The first call will execute immediately and the rest will wait the delay.\n   * Defaults to false.\n   */\n  leading?: boolean\n  /**\n   * Callback function that is called after the function is executed\n   */\n  onExecute?: (args: Parameters<TFn>, debouncer: Debouncer<TFn>) => void\n  /**\n   * Whether to execute on the trailing edge of the timeout.\n   * Defaults to true.\n   */\n  trailing?: boolean\n  /**\n   * Delay in milliseconds before executing the function.\n   * Can be a number or a function that returns a number.\n   * Defaults to 0ms\n   */\n  wait: number | ((debouncer: Debouncer<TFn>) => number)\n}\n\n/**\n * Utility function for sharing common `DebouncerOptions` options between different `Debouncer` instances.\n */\nexport function debouncerOptions<\n  TFn extends AnyFunction = AnyFunction,\n  TOptions extends Partial<DebouncerOptions<TFn>> = Partial<\n    DebouncerOptions<TFn>\n  >,\n>(options: TOptions): TOptions {\n  return options\n}\n\nconst defaultOptions: Omit<\n  Required<DebouncerOptions<any>>,\n  'initialState' | 'onExecute' | 'key'\n> = {\n  enabled: true,\n  leading: false,\n  trailing: true,\n  wait: 0,\n}\n\n/**\n * A class that creates a debounced function.\n *\n * Debouncing ensures that a function is only executed after a certain amount of time has passed\n * since its last invocation. This is useful for handling frequent events like window resizing,\n * scroll events, or input changes where you want to limit the rate of execution.\n * This synchronous version is lighter weight and often all you need - upgrade to AsyncDebouncer when you need promises, retry support, abort/cancel capabilities, or advanced error handling.\n *\n * The debounced function can be configured to execute either at the start of the delay period\n * (leading edge) or at the end (trailing edge, default). Each new call during the wait period\n * will reset the timer.\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the debouncer\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - The state includes canLeadingExecute, execution count, and isPending status\n * - State can be accessed via `debouncer.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `debouncer.state`\n *\n * @example\n * ```ts\n * const debouncer = new Debouncer((value: string) => {\n *   saveToDatabase(value);\n * }, { wait: 500 });\n *\n * // Will only save after 500ms of no new input\n * inputElement.addEventListener('input', () => {\n *   debouncer.maybeExecute(inputElement.value);\n * });\n * ```\n */\nexport class Debouncer<TFn extends AnyFunction> {\n  readonly store: Store<Readonly<DebouncerState<TFn>>> = new Store(\n    getDefaultDebouncerState<TFn>(),\n  )\n  key: string | undefined\n  options: DebouncerOptions<TFn>\n  #timeoutId: NodeJS.Timeout | undefined\n\n  constructor(\n    public fn: TFn,\n    initialOptions: DebouncerOptions<TFn>,\n  ) {\n    this.key = initialOptions.key\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n    this.#setState(this.options.initialState ?? {})\n\n    if (this.key) {\n      pacerEventClient.on('d-Debouncer', (event) => {\n        if (event.payload.key !== this.key) return\n        this.#setState(event.payload.store.state as DebouncerState<TFn>)\n        this.setOptions(event.payload.options)\n      })\n    }\n  }\n\n  /**\n   * Updates the debouncer options\n   */\n  setOptions = (newOptions: Partial<DebouncerOptions<TFn>>): void => {\n    this.options = { ...this.options, ...newOptions }\n\n    // Cancel pending execution if the debouncer is disabled\n    if (!this.#getEnabled()) {\n      this.cancel()\n    }\n  }\n\n  #setState = (newState: Partial<DebouncerState<TFn>>): void => {\n    this.store.setState((state) => {\n      const combinedState = {\n        ...state,\n        ...newState,\n      }\n      const { isPending } = combinedState\n      return {\n        ...combinedState,\n        status: !this.#getEnabled()\n          ? 'disabled'\n          : isPending\n            ? 'pending'\n            : 'idle',\n      }\n    })\n    emitChange('Debouncer', this)\n  }\n\n  /**\n   * Returns the current enabled state of the debouncer\n   */\n  #getEnabled = (): boolean => {\n    return !!parseFunctionOrValue(this.options.enabled, this)\n  }\n\n  /**\n   * Returns the current wait time in milliseconds\n   */\n  #getWait = (): number => {\n    return parseFunctionOrValue(this.options.wait, this)\n  }\n\n  /**\n   * Attempts to execute the debounced function\n   * If a call is already in progress, it will be queued\n   */\n  maybeExecute = (...args: Parameters<TFn>): void => {\n    if (!this.#getEnabled()) return undefined\n\n    this.#setState({\n      maybeExecuteCount: this.store.state.maybeExecuteCount + 1,\n    })\n\n    let _didLeadingExecute = false\n\n    // Handle leading execution\n    if (this.options.leading && this.store.state.canLeadingExecute) {\n      this.#setState({ canLeadingExecute: false })\n      _didLeadingExecute = true\n      this.#execute(...args)\n    }\n\n    // Start pending state to indicate that the debouncer is waiting for the trailing edge\n    if (this.options.trailing) {\n      this.#setState({ isPending: true, lastArgs: args })\n    }\n\n    // Clear any existing timeout\n    if (this.#timeoutId) clearTimeout(this.#timeoutId)\n\n    // Set new timeout that will reset canLeadingExecute and execute trailing only if enabled and did not execute leading\n    this.#timeoutId = setTimeout(() => {\n      this.#setState({ canLeadingExecute: true })\n      if (this.options.trailing && !_didLeadingExecute) {\n        this.#execute(...args)\n      }\n    }, this.#getWait())\n  }\n\n  #execute = (...args: Parameters<TFn>): void => {\n    if (!this.#getEnabled()) return undefined\n    this.fn(...args) // EXECUTE!\n    this.#setState({\n      executionCount: this.store.state.executionCount + 1,\n      isPending: false,\n      lastArgs: undefined,\n    })\n    this.options.onExecute?.(args, this)\n  }\n\n  /**\n   * Processes the current pending execution immediately\n   */\n  flush = (): void => {\n    if (this.store.state.isPending && this.store.state.lastArgs) {\n      this.#clearTimeout() // clear any pending timeout\n      this.#execute(...this.store.state.lastArgs) // execute immediately\n    }\n  }\n\n  #clearTimeout = (): void => {\n    if (this.#timeoutId) {\n      clearTimeout(this.#timeoutId)\n      this.#timeoutId = undefined\n    }\n  }\n\n  /**\n   * Cancels any pending execution\n   */\n  cancel = (): void => {\n    this.#clearTimeout()\n    this.#setState({\n      canLeadingExecute: true,\n      isPending: false,\n    })\n  }\n\n  /**\n   * Resets the debouncer state to its default values\n   */\n  reset = (): void => {\n    this.#setState(getDefaultDebouncerState<TFn>())\n  }\n}\n\n/**\n * Creates a debounced function that delays invoking the provided function until after a specified wait time.\n * Multiple calls during the wait period will cancel previous pending invocations and reset the timer.\n *\n * This synchronous version is lighter weight and often all you need - upgrade to asyncDebounce when you need promises, retry support, abort/cancel capabilities, or advanced error handling.\n *\n * If leading option is true, the function will execute immediately on the first call, then wait the delay\n * before allowing another execution.\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the debouncer\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - The state includes canLeadingExecute, execution count, and isPending status\n * - State can be accessed via the underlying Debouncer instance's `store.state` property\n * - When using framework adapters (React/Solid), state is accessed from the hook's state property\n *\n * @example\n * ```ts\n * const debounced = debounce(() => {\n *   saveChanges();\n * }, { wait: 1000 });\n *\n * // Called repeatedly but executes at most once per second\n * inputElement.addEventListener('input', debounced);\n * ```\n */\nexport function debounce<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: DebouncerOptions<TFn>,\n): (...args: Parameters<TFn>) => void {\n  const debouncer = new Debouncer(fn, initialOptions)\n  return debouncer.maybeExecute\n}\n"],"mappings":";;;;;AAgCA,SAAS,2BAEgB;AACvB,QAAO;EACL,mBAAmB;EACnB,gBAAgB;EAChB,WAAW;EACX,UAAU;EACV,QAAQ;EACR,mBAAmB;EACpB;;;;;AAgDH,SAAgB,iBAKd,SAA6B;AAC7B,QAAO;;AAGT,MAAMA,iBAGF;CACF,SAAS;CACT,SAAS;CACT,UAAU;CACV,MAAM;CACP;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCD,IAAa,YAAb,MAAgD;CAM9C;CAEA,YACE,AAAOC,IACP,gBACA;EAFO;eAR8C,IAAIC,uBACzD,0BAA+B,CAChC;qBA4Ba,eAAqD;AACjE,QAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;IAAY;AAGjD,OAAI,CAAC,MAAKC,YAAa,CACrB,MAAK,QAAQ;;uBAyCD,GAAG,SAAgC;AACjD,OAAI,CAAC,MAAKA,YAAa,CAAE,QAAO;AAEhC,SAAKC,SAAU,EACb,mBAAmB,KAAK,MAAM,MAAM,oBAAoB,GACzD,CAAC;GAEF,IAAI,qBAAqB;AAGzB,OAAI,KAAK,QAAQ,WAAW,KAAK,MAAM,MAAM,mBAAmB;AAC9D,UAAKA,SAAU,EAAE,mBAAmB,OAAO,CAAC;AAC5C,yBAAqB;AACrB,UAAKC,QAAS,GAAG,KAAK;;AAIxB,OAAI,KAAK,QAAQ,SACf,OAAKD,SAAU;IAAE,WAAW;IAAM,UAAU;IAAM,CAAC;AAIrD,OAAI,MAAKE,UAAY,cAAa,MAAKA,UAAW;AAGlD,SAAKA,YAAa,iBAAiB;AACjC,UAAKF,SAAU,EAAE,mBAAmB,MAAM,CAAC;AAC3C,QAAI,KAAK,QAAQ,YAAY,CAAC,mBAC5B,OAAKC,QAAS,GAAG,KAAK;MAEvB,MAAKE,SAAU,CAAC;;qBAiBD;AAClB,OAAI,KAAK,MAAM,MAAM,aAAa,KAAK,MAAM,MAAM,UAAU;AAC3D,UAAKC,cAAe;AACpB,UAAKH,QAAS,GAAG,KAAK,MAAM,MAAM,SAAS;;;sBAc1B;AACnB,SAAKG,cAAe;AACpB,SAAKJ,SAAU;IACb,mBAAmB;IACnB,WAAW;IACZ,CAAC;;qBAMgB;AAClB,SAAKA,SAAU,0BAA+B,CAAC;;AA7I/C,OAAK,MAAM,eAAe;AAC1B,OAAK,UAAU;GACb,GAAG;GACH,GAAG;GACJ;AACD,QAAKA,SAAU,KAAK,QAAQ,gBAAgB,EAAE,CAAC;AAE/C,MAAI,KAAK,IACP,uCAAiB,GAAG,gBAAgB,UAAU;AAC5C,OAAI,MAAM,QAAQ,QAAQ,KAAK,IAAK;AACpC,SAAKA,SAAU,MAAM,QAAQ,MAAM,MAA6B;AAChE,QAAK,WAAW,MAAM,QAAQ,QAAQ;IACtC;;CAgBN,aAAa,aAAiD;AAC5D,OAAK,MAAM,UAAU,UAAU;GAC7B,MAAM,gBAAgB;IACpB,GAAG;IACH,GAAG;IACJ;GACD,MAAM,EAAE,cAAc;AACtB,UAAO;IACL,GAAG;IACH,QAAQ,CAAC,MAAKD,YAAa,GACvB,aACA,YACE,YACA;IACP;IACD;AACF,kCAAW,aAAa,KAAK;;;;;CAM/B,oBAA6B;AAC3B,SAAO,CAAC,CAACM,mCAAqB,KAAK,QAAQ,SAAS,KAAK;;;;;CAM3D,iBAAyB;AACvB,SAAOA,mCAAqB,KAAK,QAAQ,MAAM,KAAK;;CAwCtD,YAAY,GAAG,SAAgC;AAC7C,MAAI,CAAC,MAAKN,YAAa,CAAE,QAAO;AAChC,OAAK,GAAG,GAAG,KAAK;AAChB,QAAKC,SAAU;GACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB;GAClD,WAAW;GACX,UAAU;GACX,CAAC;AACF,OAAK,QAAQ,YAAY,MAAM,KAAK;;CAatC,sBAA4B;AAC1B,MAAI,MAAKE,WAAY;AACnB,gBAAa,MAAKA,UAAW;AAC7B,SAAKA,YAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkDxB,SAAgB,SACd,IACA,gBACoC;AAEpC,QADkB,IAAI,UAAU,IAAI,eAAe,CAClC"}

package/dist/debouncer.d.cts

@@ -0,0 +1,167 @@
+import { AnyFunction } from "./types.cjs";
+import { Store } from "@tanstack/store";
+
+//#region src/debouncer.d.ts
+interface DebouncerState<TFn extends AnyFunction> {
+  /**
+   * Whether the debouncer can execute on the leading edge of the timeout
+   */
+  canLeadingExecute: boolean;
+  /**
+   * Number of function executions that have been completed
+   */
+  executionCount: number;
+  /**
+   * Whether the debouncer is waiting for the timeout to trigger execution
+   */
+  isPending: boolean;
+  /**
+   * The arguments from the most recent call to maybeExecute
+   */
+  lastArgs: Parameters<TFn> | undefined;
+  /**
+   * Number of times maybeExecute has been called (for reduction calculations)
+   */
+  maybeExecuteCount: number;
+  /**
+   * Current execution status - 'idle' when not active, 'pending' when waiting for timeout
+   */
+  status: 'disabled' | 'idle' | 'pending';
+}
+/**
+ * Options for configuring a debounced function
+ */
+interface DebouncerOptions<TFn extends AnyFunction> {
+  /**
+   * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.
+   * Can be a boolean or a function that returns a boolean.
+   * Defaults to true.
+   */
+  enabled?: boolean | ((debouncer: Debouncer<TFn>) => boolean);
+  /**
+   * Initial state for the debouncer
+   */
+  initialState?: Partial<DebouncerState<TFn>>;
+  /**
+   * A key to identify the debouncer.
+   * If provided, the debouncer will be identified by this key in the devtools and PacerProvider if applicable.
+   */
+  key?: string;
+  /**
+   * Whether to execute on the leading edge of the timeout.
+   * The first call will execute immediately and the rest will wait the delay.
+   * Defaults to false.
+   */
+  leading?: boolean;
+  /**
+   * Callback function that is called after the function is executed
+   */
+  onExecute?: (args: Parameters<TFn>, debouncer: Debouncer<TFn>) => void;
+  /**
+   * Whether to execute on the trailing edge of the timeout.
+   * Defaults to true.
+   */
+  trailing?: boolean;
+  /**
+   * Delay in milliseconds before executing the function.
+   * Can be a number or a function that returns a number.
+   * Defaults to 0ms
+   */
+  wait: number | ((debouncer: Debouncer<TFn>) => number);
+}
+/**
+ * Utility function for sharing common `DebouncerOptions` options between different `Debouncer` instances.
+ */
+declare function debouncerOptions<TFn extends AnyFunction = AnyFunction, TOptions extends Partial<DebouncerOptions<TFn>> = Partial<DebouncerOptions<TFn>>>(options: TOptions): TOptions;
+/**
+ * A class that creates a debounced function.
+ *
+ * Debouncing ensures that a function is only executed after a certain amount of time has passed
+ * since its last invocation. This is useful for handling frequent events like window resizing,
+ * scroll events, or input changes where you want to limit the rate of execution.
+ * This synchronous version is lighter weight and often all you need - upgrade to AsyncDebouncer when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+ *
+ * The debounced function can be configured to execute either at the start of the delay period
+ * (leading edge) or at the end (trailing edge, default). Each new call during the wait period
+ * will reset the timer.
+ *
+ * State Management:
+ * - Uses TanStack Store for reactive state management
+ * - Use `initialState` to provide initial state values when creating the debouncer
+ * - Use `onExecute` callback to react to function execution and implement custom logic
+ * - The state includes canLeadingExecute, execution count, and isPending status
+ * - State can be accessed via `debouncer.store.state` when using the class directly
+ * - When using framework adapters (React/Solid), state is accessed from `debouncer.state`
+ *
+ * @example
+ * ```ts
+ * const debouncer = new Debouncer((value: string) => {
+ *   saveToDatabase(value);
+ * }, { wait: 500 });
+ *
+ * // Will only save after 500ms of no new input
+ * inputElement.addEventListener('input', () => {
+ *   debouncer.maybeExecute(inputElement.value);
+ * });
+ * ```
+ */
+declare class Debouncer<TFn extends AnyFunction> {
+  #private;
+  fn: TFn;
+  readonly store: Store<Readonly<DebouncerState<TFn>>>;
+  key: string | undefined;
+  options: DebouncerOptions<TFn>;
+  constructor(fn: TFn, initialOptions: DebouncerOptions<TFn>);
+  /**
+   * Updates the debouncer options
+   */
+  setOptions: (newOptions: Partial<DebouncerOptions<TFn>>) => void;
+  /**
+   * Attempts to execute the debounced function
+   * If a call is already in progress, it will be queued
+   */
+  maybeExecute: (...args: Parameters<TFn>) => void;
+  /**
+   * Processes the current pending execution immediately
+   */
+  flush: () => void;
+  /**
+   * Cancels any pending execution
+   */
+  cancel: () => void;
+  /**
+   * Resets the debouncer state to its default values
+   */
+  reset: () => void;
+}
+/**
+ * Creates a debounced function that delays invoking the provided function until after a specified wait time.
+ * Multiple calls during the wait period will cancel previous pending invocations and reset the timer.
+ *
+ * This synchronous version is lighter weight and often all you need - upgrade to asyncDebounce when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+ *
+ * If leading option is true, the function will execute immediately on the first call, then wait the delay
+ * before allowing another execution.
+ *
+ * State Management:
+ * - Uses TanStack Store for reactive state management
+ * - Use `initialState` to provide initial state values when creating the debouncer
+ * - Use `onExecute` callback to react to function execution and implement custom logic
+ * - The state includes canLeadingExecute, execution count, and isPending status
+ * - State can be accessed via the underlying Debouncer instance's `store.state` property
+ * - When using framework adapters (React/Solid), state is accessed from the hook's state property
+ *
+ * @example
+ * ```ts
+ * const debounced = debounce(() => {
+ *   saveChanges();
+ * }, { wait: 1000 });
+ *
+ * // Called repeatedly but executes at most once per second
+ * inputElement.addEventListener('input', debounced);
+ * ```
+ */
+declare function debounce<TFn extends AnyFunction>(fn: TFn, initialOptions: DebouncerOptions<TFn>): (...args: Parameters<TFn>) => void;
+//#endregion
+export { Debouncer, DebouncerOptions, DebouncerState, debounce, debouncerOptions };
+//# sourceMappingURL=debouncer.d.cts.map

package/dist/debouncer.d.ts

@@ -0,0 +1,167 @@
+import { AnyFunction } from "./types.js";
+import { Store } from "@tanstack/store";
+
+//#region src/debouncer.d.ts
+interface DebouncerState<TFn extends AnyFunction> {
+  /**
+   * Whether the debouncer can execute on the leading edge of the timeout
+   */
+  canLeadingExecute: boolean;
+  /**
+   * Number of function executions that have been completed
+   */
+  executionCount: number;
+  /**
+   * Whether the debouncer is waiting for the timeout to trigger execution
+   */
+  isPending: boolean;
+  /**
+   * The arguments from the most recent call to maybeExecute
+   */
+  lastArgs: Parameters<TFn> | undefined;
+  /**
+   * Number of times maybeExecute has been called (for reduction calculations)
+   */
+  maybeExecuteCount: number;
+  /**
+   * Current execution status - 'idle' when not active, 'pending' when waiting for timeout
+   */
+  status: 'disabled' | 'idle' | 'pending';
+}
+/**
+ * Options for configuring a debounced function
+ */
+interface DebouncerOptions<TFn extends AnyFunction> {
+  /**
+   * Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions.
+   * Can be a boolean or a function that returns a boolean.
+   * Defaults to true.
+   */
+  enabled?: boolean | ((debouncer: Debouncer<TFn>) => boolean);
+  /**
+   * Initial state for the debouncer
+   */
+  initialState?: Partial<DebouncerState<TFn>>;
+  /**
+   * A key to identify the debouncer.
+   * If provided, the debouncer will be identified by this key in the devtools and PacerProvider if applicable.
+   */
+  key?: string;
+  /**
+   * Whether to execute on the leading edge of the timeout.
+   * The first call will execute immediately and the rest will wait the delay.
+   * Defaults to false.
+   */
+  leading?: boolean;
+  /**
+   * Callback function that is called after the function is executed
+   */
+  onExecute?: (args: Parameters<TFn>, debouncer: Debouncer<TFn>) => void;
+  /**
+   * Whether to execute on the trailing edge of the timeout.
+   * Defaults to true.
+   */
+  trailing?: boolean;
+  /**
+   * Delay in milliseconds before executing the function.
+   * Can be a number or a function that returns a number.
+   * Defaults to 0ms
+   */
+  wait: number | ((debouncer: Debouncer<TFn>) => number);
+}
+/**
+ * Utility function for sharing common `DebouncerOptions` options between different `Debouncer` instances.
+ */
+declare function debouncerOptions<TFn extends AnyFunction = AnyFunction, TOptions extends Partial<DebouncerOptions<TFn>> = Partial<DebouncerOptions<TFn>>>(options: TOptions): TOptions;
+/**
+ * A class that creates a debounced function.
+ *
+ * Debouncing ensures that a function is only executed after a certain amount of time has passed
+ * since its last invocation. This is useful for handling frequent events like window resizing,
+ * scroll events, or input changes where you want to limit the rate of execution.
+ * This synchronous version is lighter weight and often all you need - upgrade to AsyncDebouncer when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+ *
+ * The debounced function can be configured to execute either at the start of the delay period
+ * (leading edge) or at the end (trailing edge, default). Each new call during the wait period
+ * will reset the timer.
+ *
+ * State Management:
+ * - Uses TanStack Store for reactive state management
+ * - Use `initialState` to provide initial state values when creating the debouncer
+ * - Use `onExecute` callback to react to function execution and implement custom logic
+ * - The state includes canLeadingExecute, execution count, and isPending status
+ * - State can be accessed via `debouncer.store.state` when using the class directly
+ * - When using framework adapters (React/Solid), state is accessed from `debouncer.state`
+ *
+ * @example
+ * ```ts
+ * const debouncer = new Debouncer((value: string) => {
+ *   saveToDatabase(value);
+ * }, { wait: 500 });
+ *
+ * // Will only save after 500ms of no new input
+ * inputElement.addEventListener('input', () => {
+ *   debouncer.maybeExecute(inputElement.value);
+ * });
+ * ```
+ */
+declare class Debouncer<TFn extends AnyFunction> {
+  #private;
+  fn: TFn;
+  readonly store: Store<Readonly<DebouncerState<TFn>>>;
+  key: string | undefined;
+  options: DebouncerOptions<TFn>;
+  constructor(fn: TFn, initialOptions: DebouncerOptions<TFn>);
+  /**
+   * Updates the debouncer options
+   */
+  setOptions: (newOptions: Partial<DebouncerOptions<TFn>>) => void;
+  /**
+   * Attempts to execute the debounced function
+   * If a call is already in progress, it will be queued
+   */
+  maybeExecute: (...args: Parameters<TFn>) => void;
+  /**
+   * Processes the current pending execution immediately
+   */
+  flush: () => void;
+  /**
+   * Cancels any pending execution
+   */
+  cancel: () => void;
+  /**
+   * Resets the debouncer state to its default values
+   */
+  reset: () => void;
+}
+/**
+ * Creates a debounced function that delays invoking the provided function until after a specified wait time.
+ * Multiple calls during the wait period will cancel previous pending invocations and reset the timer.
+ *
+ * This synchronous version is lighter weight and often all you need - upgrade to asyncDebounce when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+ *
+ * If leading option is true, the function will execute immediately on the first call, then wait the delay
+ * before allowing another execution.
+ *
+ * State Management:
+ * - Uses TanStack Store for reactive state management
+ * - Use `initialState` to provide initial state values when creating the debouncer
+ * - Use `onExecute` callback to react to function execution and implement custom logic
+ * - The state includes canLeadingExecute, execution count, and isPending status
+ * - State can be accessed via the underlying Debouncer instance's `store.state` property
+ * - When using framework adapters (React/Solid), state is accessed from the hook's state property
+ *
+ * @example
+ * ```ts
+ * const debounced = debounce(() => {
+ *   saveChanges();
+ * }, { wait: 1000 });
+ *
+ * // Called repeatedly but executes at most once per second
+ * inputElement.addEventListener('input', debounced);
+ * ```
+ */
+declare function debounce<TFn extends AnyFunction>(fn: TFn, initialOptions: DebouncerOptions<TFn>): (...args: Parameters<TFn>) => void;
+//#endregion
+export { Debouncer, DebouncerOptions, DebouncerState, debounce, debouncerOptions };
+//# sourceMappingURL=debouncer.d.ts.map