@tanstack/pacer 0.16.3 → 0.17.0

package/dist/throttler.cjs

@@ -0,0 +1,209 @@
+const require_utils = require('./utils.cjs');
+const require_event_client = require('./event-client.cjs');
+let __tanstack_store = require("@tanstack/store");
+
+//#region src/throttler.ts
+function getDefaultThrottlerState() {
+	return {
+		executionCount: 0,
+		isPending: false,
+		lastArgs: void 0,
+		lastExecutionTime: 0,
+		nextExecutionTime: 0,
+		status: "idle",
+		maybeExecuteCount: 0
+	};
+}
+/**
+* Utility function for sharing common `ThrottlerOptions` options between different `Throttler` instances.
+*/
+function throttlerOptions(options) {
+	return options;
+}
+const defaultOptions = {
+	enabled: true,
+	leading: true,
+	trailing: true,
+	wait: 0
+};
+/**
+* A class that creates a throttled function.
+*
+* Throttling ensures a function is called at most once within a specified time window.
+* Unlike debouncing which waits for a pause in calls, throttling guarantees consistent
+* execution timing regardless of call frequency.
+* This synchronous version is lighter weight and often all you need - upgrade to AsyncThrottler when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+*
+* Supports both leading and trailing edge execution:
+* - Leading: Execute immediately on first call (default: true)
+* - Trailing: Execute after wait period if called during throttle (default: true)
+*
+* For collapsing rapid-fire events where you only care about the last call, consider using Debouncer.
+*
+* State Management:
+* - Uses TanStack Store for reactive state management
+* - Use `initialState` to provide initial state values when creating the throttler
+* - Use `onExecute` callback to react to function execution and implement custom logic
+* - The state includes execution count, last execution time, pending status, and more
+* - State can be accessed via `throttler.store.state` when using the class directly
+* - When using framework adapters (React/Solid), state is accessed from `throttler.state`
+*
+* @example
+* ```ts
+* const throttler = new Throttler(
+*   (id: string) => api.getData(id),
+*   { wait: 1000 } // Execute at most once per second
+* );
+*
+* // First call executes immediately
+* throttler.maybeExecute('123');
+*
+* // Subsequent calls within 1000ms are throttled
+* throttler.maybeExecute('123'); // Throttled
+* ```
+*/
+var Throttler = class {
+	#timeoutId;
+	constructor(fn, initialOptions) {
+		this.fn = fn;
+		this.store = new __tanstack_store.Store(getDefaultThrottlerState());
+		this.setOptions = (newOptions) => {
+			this.options = {
+				...this.options,
+				...newOptions
+			};
+			if (!this.#getEnabled()) this.cancel();
+		};
+		this.maybeExecute = (...args) => {
+			this.#setState({ maybeExecuteCount: this.store.state.maybeExecuteCount + 1 });
+			const now = Date.now();
+			const timeSinceLastExecution = now - this.store.state.lastExecutionTime;
+			const wait = this.#getWait();
+			if (this.options.leading && timeSinceLastExecution >= wait) this.#execute(...args);
+			else {
+				this.#setState({ lastArgs: args });
+				if (!this.#timeoutId && this.options.trailing) {
+					const timeoutDuration = wait - (this.store.state.lastExecutionTime ? now - this.store.state.lastExecutionTime : 0);
+					this.#setState({ isPending: true });
+					this.#timeoutId = setTimeout(() => {
+						const { lastArgs } = this.store.state;
+						if (lastArgs !== void 0) this.#execute(...lastArgs);
+					}, timeoutDuration);
+				}
+			}
+		};
+		this.flush = () => {
+			if (this.store.state.isPending && this.store.state.lastArgs) this.#execute(...this.store.state.lastArgs);
+		};
+		this.cancel = () => {
+			this.#clearTimeout();
+			this.#setState({
+				lastArgs: void 0,
+				isPending: false
+			});
+		};
+		this.reset = () => {
+			this.#setState(getDefaultThrottlerState());
+		};
+		this.key = initialOptions.key;
+		this.options = {
+			...defaultOptions,
+			...initialOptions
+		};
+		this.#setState(this.options.initialState ?? {});
+		if (this.key) require_event_client.pacerEventClient.on("d-Throttler", (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("Throttler", this);
+	};
+	#getEnabled = () => {
+		return !!require_utils.parseFunctionOrValue(this.options.enabled, this);
+	};
+	#getWait = () => {
+		return require_utils.parseFunctionOrValue(this.options.wait, this);
+	};
+	#execute = (...args) => {
+		if (!this.#getEnabled()) return;
+		this.fn(...args);
+		const lastExecutionTime = Date.now();
+		const nextExecutionTime = lastExecutionTime + this.#getWait();
+		this.#clearTimeout();
+		this.#setState({
+			executionCount: this.store.state.executionCount + 1,
+			lastExecutionTime,
+			nextExecutionTime,
+			isPending: false,
+			lastArgs: void 0
+		});
+		this.options.onExecute?.(args, this);
+		setTimeout(() => {
+			if (!this.store.state.isPending) this.#setState({ nextExecutionTime: void 0 });
+		}, this.#getWait());
+	};
+	#clearTimeout = () => {
+		if (this.#timeoutId) {
+			clearTimeout(this.#timeoutId);
+			this.#timeoutId = void 0;
+		}
+	};
+};
+/**
+* Creates a throttled function that limits how often the provided function can execute.
+*
+* This synchronous version is lighter weight and often all you need - upgrade to asyncThrottle when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+*
+* Throttling ensures a function executes at most once within a specified time window,
+* regardless of how many times it is called. This is useful for rate-limiting
+* expensive operations or UI updates.
+*
+* The throttled function can be configured to execute on the leading and/or trailing
+* edge of the throttle window via options.
+*
+* For handling bursts of events, consider using debounce() instead. For hard execution
+* limits, consider using rateLimit().
+*
+* State Management:
+* - Uses TanStack Store for reactive state management
+* - Use `initialState` to provide initial state values when creating the throttler
+* - Use `onExecute` callback to react to function execution and implement custom logic
+* - The state includes execution count, last execution time, pending status, and more
+* - State can be accessed via the underlying Throttler instance's `store.state` property
+* - When using framework adapters (React/Solid), state is accessed from the hook's state property
+*
+* @example
+* ```ts
+* // Basic throttling - max once per second
+* const throttled = throttle(updateUI, { wait: 1000 });
+*
+* // Configure leading/trailing execution
+* const throttled = throttle(saveData, {
+*   wait: 2000,
+*   leading: true,  // Execute immediately on first call
+*   trailing: true  // Execute again after delay if called during wait
+* });
+* ```
+*/
+function throttle(fn, initialOptions) {
+	return new Throttler(fn, initialOptions).maybeExecute;
+}
+
+//#endregion
+exports.Throttler = Throttler;
+exports.throttle = throttle;
+exports.throttlerOptions = throttlerOptions;
+//# sourceMappingURL=throttler.cjs.map

package/dist/throttler.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"throttler.cjs","names":["defaultOptions: Omit<\n  Required<ThrottlerOptions<any>>,\n  'initialState' | 'onExecute' | 'key'\n>","fn: TFn","Store","#getEnabled","#setState","#getWait","#execute","#timeoutId","#clearTimeout","parseFunctionOrValue"],"sources":["../src/throttler.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 ThrottlerState<TFn extends AnyFunction> {\n  /**\n   * Number of function executions that have been completed\n   */\n  executionCount: number\n  /**\n   * Whether the throttler 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   * Timestamp of the last function execution in milliseconds\n   */\n  lastExecutionTime: number\n  /**\n   * Number of times maybeExecute has been called (for reduction calculations)\n   */\n  maybeExecuteCount: number\n  /**\n   * Timestamp when the next execution can occur in milliseconds\n   */\n  nextExecutionTime: number | undefined\n  /**\n   * Current execution status - 'idle' when not active, 'pending' when waiting for timeout\n   */\n  status: 'disabled' | 'idle' | 'pending'\n}\n\nfunction getDefaultThrottlerState<\n  TFn extends AnyFunction,\n>(): ThrottlerState<TFn> {\n  return {\n    executionCount: 0,\n    isPending: false,\n    lastArgs: undefined,\n    lastExecutionTime: 0,\n    nextExecutionTime: 0,\n    status: 'idle',\n    maybeExecuteCount: 0,\n  }\n}\n\n/**\n * Options for configuring a throttled function\n */\nexport interface ThrottlerOptions<TFn extends AnyFunction> {\n  /**\n   * Whether the throttler 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 | ((throttler: Throttler<TFn>) => boolean)\n  /**\n   * Initial state for the throttler\n   */\n  initialState?: Partial<ThrottlerState<TFn>>\n  /**\n   * A key to identify the throttler.\n   * If provided, the throttler 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   * Defaults to true.\n   */\n  leading?: boolean\n  /**\n   * Callback function that is called after the function is executed\n   */\n  onExecute?: (args: Parameters<TFn>, throttler: Throttler<TFn>) => void\n  /**\n   * Whether to execute on the trailing edge of the timeout.\n   * Defaults to true.\n   */\n  trailing?: boolean\n  /**\n   * Time window in milliseconds during which the function can only be executed once.\n   * Can be a number or a function that returns a number.\n   * Defaults to 0ms\n   */\n  wait: number | ((throttler: Throttler<TFn>) => number)\n}\n\n/**\n * Utility function for sharing common `ThrottlerOptions` options between different `Throttler` instances.\n */\nexport function throttlerOptions<\n  TFn extends AnyFunction = AnyFunction,\n  TOptions extends Partial<ThrottlerOptions<TFn>> = Partial<\n    ThrottlerOptions<TFn>\n  >,\n>(options: TOptions): TOptions {\n  return options\n}\n\nconst defaultOptions: Omit<\n  Required<ThrottlerOptions<any>>,\n  'initialState' | 'onExecute' | 'key'\n> = {\n  enabled: true,\n  leading: true,\n  trailing: true,\n  wait: 0,\n}\n\n/**\n * A class that creates a throttled function.\n *\n * Throttling ensures a function is called at most once within a specified time window.\n * Unlike debouncing which waits for a pause in calls, throttling guarantees consistent\n * execution timing regardless of call frequency.\n * This synchronous version is lighter weight and often all you need - upgrade to AsyncThrottler when you need promises, retry support, abort/cancel capabilities, or advanced error handling.\n *\n * Supports both leading and trailing edge execution:\n * - Leading: Execute immediately on first call (default: true)\n * - Trailing: Execute after wait period if called during throttle (default: true)\n *\n * For collapsing rapid-fire events where you only care about the last call, consider using Debouncer.\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the throttler\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - The state includes execution count, last execution time, pending status, and more\n * - State can be accessed via `throttler.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `throttler.state`\n *\n * @example\n * ```ts\n * const throttler = new Throttler(\n *   (id: string) => api.getData(id),\n *   { wait: 1000 } // Execute at most once per second\n * );\n *\n * // First call executes immediately\n * throttler.maybeExecute('123');\n *\n * // Subsequent calls within 1000ms are throttled\n * throttler.maybeExecute('123'); // Throttled\n * ```\n */\nexport class Throttler<TFn extends AnyFunction> {\n  readonly store: Store<Readonly<ThrottlerState<TFn>>> = new Store(\n    getDefaultThrottlerState(),\n  )\n  key: string | undefined\n  options: ThrottlerOptions<TFn>\n  #timeoutId: NodeJS.Timeout | undefined\n\n  constructor(\n    public fn: TFn,\n    initialOptions: ThrottlerOptions<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-Throttler', (event) => {\n        if (event.payload.key !== this.key) return\n        this.#setState(event.payload.store.state as ThrottlerState<TFn>)\n        this.setOptions(event.payload.options)\n      })\n    }\n  }\n\n  /**\n   * Updates the throttler options\n   */\n  setOptions = (newOptions: Partial<ThrottlerOptions<TFn>>): void => {\n    this.options = { ...this.options, ...newOptions }\n\n    // Cancel pending execution if the throttler is disabled\n    if (!this.#getEnabled()) {\n      this.cancel()\n    }\n  }\n\n  #setState = (newState: Partial<ThrottlerState<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('Throttler', this)\n  }\n\n  #getEnabled = (): boolean => {\n    return !!parseFunctionOrValue(this.options.enabled, this)\n  }\n\n  #getWait = (): number => {\n    return parseFunctionOrValue(this.options.wait, this)\n  }\n\n  /**\n   * Attempts to execute the throttled function. The execution behavior depends on the throttler options:\n   *\n   * - If enough time has passed since the last execution (>= wait period):\n   *   - With leading=true: Executes immediately\n   *   - With leading=false: Waits for the next trailing execution\n   *\n   * - If within the wait period:\n   *   - With trailing=true: Schedules execution for end of wait period\n   *   - With trailing=false: Drops the execution\n   *\n   * @example\n   * ```ts\n   * const throttled = new Throttler(fn, { wait: 1000 });\n   *\n   * // First call executes immediately\n   * throttled.maybeExecute('a', 'b');\n   *\n   * // Call during wait period - gets throttled\n   * throttled.maybeExecute('c', 'd');\n   * ```\n   */\n  maybeExecute = (...args: Parameters<TFn>): void => {\n    this.#setState({\n      maybeExecuteCount: this.store.state.maybeExecuteCount + 1,\n    })\n\n    const now = Date.now()\n    const timeSinceLastExecution = now - this.store.state.lastExecutionTime\n    const wait = this.#getWait()\n\n    // Handle leading execution\n    if (this.options.leading && timeSinceLastExecution >= wait) {\n      this.#execute(...args)\n    } else {\n      // Store the most recent arguments for potential trailing execution\n      this.#setState({\n        lastArgs: args,\n      })\n      // Set up trailing execution if not already scheduled\n      if (!this.#timeoutId && this.options.trailing) {\n        // prevent large number if lastExecutionTime is undefined\n        const _timeSinceLastExecution = this.store.state.lastExecutionTime\n          ? now - this.store.state.lastExecutionTime\n          : 0\n        const timeoutDuration = wait - _timeSinceLastExecution\n        this.#setState({ isPending: true })\n        this.#timeoutId = setTimeout(() => {\n          const { lastArgs } = this.store.state\n          if (lastArgs !== undefined) {\n            this.#execute(...lastArgs)\n          }\n        }, timeoutDuration)\n      }\n    }\n  }\n\n  #execute = (...args: Parameters<TFn>): void => {\n    if (!this.#getEnabled()) return\n    this.fn(...args) // EXECUTE!\n    const lastExecutionTime = Date.now()\n    const nextExecutionTime = lastExecutionTime + this.#getWait()\n    this.#clearTimeout()\n    this.#setState({\n      executionCount: this.store.state.executionCount + 1,\n      lastExecutionTime,\n      nextExecutionTime,\n      isPending: false,\n      lastArgs: undefined,\n    })\n    this.options.onExecute?.(args, this)\n    setTimeout(() => {\n      if (!this.store.state.isPending) {\n        this.#setState({ nextExecutionTime: undefined })\n      }\n    }, this.#getWait())\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.#execute(...this.store.state.lastArgs)\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 trailing execution and clears internal state.\n   *\n   * If a trailing execution is scheduled (due to throttling with trailing=true),\n   * this will prevent that execution from occurring. The internal timeout and\n   * stored arguments will be cleared.\n   *\n   * Has no effect if there is no pending execution.\n   */\n  cancel = (): void => {\n    this.#clearTimeout()\n    this.#setState({\n      lastArgs: undefined,\n      isPending: false,\n    })\n  }\n\n  /**\n   * Resets the throttler state to its default values\n   */\n  reset = (): void => {\n    this.#setState(getDefaultThrottlerState<TFn>())\n  }\n}\n\n/**\n * Creates a throttled function that limits how often the provided function can execute.\n *\n * This synchronous version is lighter weight and often all you need - upgrade to asyncThrottle when you need promises, retry support, abort/cancel capabilities, or advanced error handling.\n *\n * Throttling ensures a function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting\n * expensive operations or UI updates.\n *\n * The throttled function can be configured to execute on the leading and/or trailing\n * edge of the throttle window via options.\n *\n * For handling bursts of events, consider using debounce() instead. For hard execution\n * limits, consider using rateLimit().\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the throttler\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - The state includes execution count, last execution time, pending status, and more\n * - State can be accessed via the underlying Throttler 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 * // Basic throttling - max once per second\n * const throttled = throttle(updateUI, { wait: 1000 });\n *\n * // Configure leading/trailing execution\n * const throttled = throttle(saveData, {\n *   wait: 2000,\n *   leading: true,  // Execute immediately on first call\n *   trailing: true  // Execute again after delay if called during wait\n * });\n * ```\n */\nexport function throttle<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: ThrottlerOptions<TFn>,\n) {\n  const throttler = new Throttler(fn, initialOptions)\n  return throttler.maybeExecute\n}\n"],"mappings":";;;;;AAoCA,SAAS,2BAEgB;AACvB,QAAO;EACL,gBAAgB;EAChB,WAAW;EACX,UAAU;EACV,mBAAmB;EACnB,mBAAmB;EACnB,QAAQ;EACR,mBAAmB;EACpB;;;;;AA+CH,SAAgB,iBAKd,SAA6B;AAC7B,QAAO;;AAGT,MAAMA,iBAGF;CACF,SAAS;CACT,SAAS;CACT,UAAU;CACV,MAAM;CACP;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCD,IAAa,YAAb,MAAgD;CAM9C;CAEA,YACE,AAAOC,IACP,gBACA;EAFO;eAR8C,IAAIC,uBACzD,0BAA0B,CAC3B;qBA4Ba,eAAqD;AACjE,QAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;IAAY;AAGjD,OAAI,CAAC,MAAKC,YAAa,CACrB,MAAK,QAAQ;;uBAqDD,GAAG,SAAgC;AACjD,SAAKC,SAAU,EACb,mBAAmB,KAAK,MAAM,MAAM,oBAAoB,GACzD,CAAC;GAEF,MAAM,MAAM,KAAK,KAAK;GACtB,MAAM,yBAAyB,MAAM,KAAK,MAAM,MAAM;GACtD,MAAM,OAAO,MAAKC,SAAU;AAG5B,OAAI,KAAK,QAAQ,WAAW,0BAA0B,KACpD,OAAKC,QAAS,GAAG,KAAK;QACjB;AAEL,UAAKF,SAAU,EACb,UAAU,MACX,CAAC;AAEF,QAAI,CAAC,MAAKG,aAAc,KAAK,QAAQ,UAAU;KAK7C,MAAM,kBAAkB,QAHQ,KAAK,MAAM,MAAM,oBAC7C,MAAM,KAAK,MAAM,MAAM,oBACvB;AAEJ,WAAKH,SAAU,EAAE,WAAW,MAAM,CAAC;AACnC,WAAKG,YAAa,iBAAiB;MACjC,MAAM,EAAE,aAAa,KAAK,MAAM;AAChC,UAAI,aAAa,OACf,OAAKD,QAAS,GAAG,SAAS;QAE3B,gBAAgB;;;;qBA6BL;AAClB,OAAI,KAAK,MAAM,MAAM,aAAa,KAAK,MAAM,MAAM,SACjD,OAAKA,QAAS,GAAG,KAAK,MAAM,MAAM,SAAS;;sBAoB1B;AACnB,SAAKE,cAAe;AACpB,SAAKJ,SAAU;IACb,UAAU;IACV,WAAW;IACZ,CAAC;;qBAMgB;AAClB,SAAKA,SAAU,0BAA+B,CAAC;;AA1K/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;;CAG/B,oBAA6B;AAC3B,SAAO,CAAC,CAACM,mCAAqB,KAAK,QAAQ,SAAS,KAAK;;CAG3D,iBAAyB;AACvB,SAAOA,mCAAqB,KAAK,QAAQ,MAAM,KAAK;;CA4DtD,YAAY,GAAG,SAAgC;AAC7C,MAAI,CAAC,MAAKN,YAAa,CAAE;AACzB,OAAK,GAAG,GAAG,KAAK;EAChB,MAAM,oBAAoB,KAAK,KAAK;EACpC,MAAM,oBAAoB,oBAAoB,MAAKE,SAAU;AAC7D,QAAKG,cAAe;AACpB,QAAKJ,SAAU;GACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB;GAClD;GACA;GACA,WAAW;GACX,UAAU;GACX,CAAC;AACF,OAAK,QAAQ,YAAY,MAAM,KAAK;AACpC,mBAAiB;AACf,OAAI,CAAC,KAAK,MAAM,MAAM,UACpB,OAAKA,SAAU,EAAE,mBAAmB,QAAW,CAAC;KAEjD,MAAKC,SAAU,CAAC;;CAYrB,sBAA4B;AAC1B,MAAI,MAAKE,WAAY;AACnB,gBAAa,MAAKA,UAAW;AAC7B,SAAKA,YAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiExB,SAAgB,SACd,IACA,gBACA;AAEA,QADkB,IAAI,UAAU,IAAI,eAAe,CAClC"}

package/dist/throttler.d.cts

@@ -0,0 +1,207 @@
+import { AnyFunction } from "./types.cjs";
+import { Store } from "@tanstack/store";
+
+//#region src/throttler.d.ts
+interface ThrottlerState<TFn extends AnyFunction> {
+  /**
+   * Number of function executions that have been completed
+   */
+  executionCount: number;
+  /**
+   * Whether the throttler is waiting for the timeout to trigger execution
+   */
+  isPending: boolean;
+  /**
+   * The arguments from the most recent call to maybeExecute
+   */
+  lastArgs: Parameters<TFn> | undefined;
+  /**
+   * Timestamp of the last function execution in milliseconds
+   */
+  lastExecutionTime: number;
+  /**
+   * Number of times maybeExecute has been called (for reduction calculations)
+   */
+  maybeExecuteCount: number;
+  /**
+   * Timestamp when the next execution can occur in milliseconds
+   */
+  nextExecutionTime: number | undefined;
+  /**
+   * Current execution status - 'idle' when not active, 'pending' when waiting for timeout
+   */
+  status: 'disabled' | 'idle' | 'pending';
+}
+/**
+ * Options for configuring a throttled function
+ */
+interface ThrottlerOptions<TFn extends AnyFunction> {
+  /**
+   * Whether the throttler 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 | ((throttler: Throttler<TFn>) => boolean);
+  /**
+   * Initial state for the throttler
+   */
+  initialState?: Partial<ThrottlerState<TFn>>;
+  /**
+   * A key to identify the throttler.
+   * If provided, the throttler 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.
+   * Defaults to true.
+   */
+  leading?: boolean;
+  /**
+   * Callback function that is called after the function is executed
+   */
+  onExecute?: (args: Parameters<TFn>, throttler: Throttler<TFn>) => void;
+  /**
+   * Whether to execute on the trailing edge of the timeout.
+   * Defaults to true.
+   */
+  trailing?: boolean;
+  /**
+   * Time window in milliseconds during which the function can only be executed once.
+   * Can be a number or a function that returns a number.
+   * Defaults to 0ms
+   */
+  wait: number | ((throttler: Throttler<TFn>) => number);
+}
+/**
+ * Utility function for sharing common `ThrottlerOptions` options between different `Throttler` instances.
+ */
+declare function throttlerOptions<TFn extends AnyFunction = AnyFunction, TOptions extends Partial<ThrottlerOptions<TFn>> = Partial<ThrottlerOptions<TFn>>>(options: TOptions): TOptions;
+/**
+ * A class that creates a throttled function.
+ *
+ * Throttling ensures a function is called at most once within a specified time window.
+ * Unlike debouncing which waits for a pause in calls, throttling guarantees consistent
+ * execution timing regardless of call frequency.
+ * This synchronous version is lighter weight and often all you need - upgrade to AsyncThrottler when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+ *
+ * Supports both leading and trailing edge execution:
+ * - Leading: Execute immediately on first call (default: true)
+ * - Trailing: Execute after wait period if called during throttle (default: true)
+ *
+ * For collapsing rapid-fire events where you only care about the last call, consider using Debouncer.
+ *
+ * State Management:
+ * - Uses TanStack Store for reactive state management
+ * - Use `initialState` to provide initial state values when creating the throttler
+ * - Use `onExecute` callback to react to function execution and implement custom logic
+ * - The state includes execution count, last execution time, pending status, and more
+ * - State can be accessed via `throttler.store.state` when using the class directly
+ * - When using framework adapters (React/Solid), state is accessed from `throttler.state`
+ *
+ * @example
+ * ```ts
+ * const throttler = new Throttler(
+ *   (id: string) => api.getData(id),
+ *   { wait: 1000 } // Execute at most once per second
+ * );
+ *
+ * // First call executes immediately
+ * throttler.maybeExecute('123');
+ *
+ * // Subsequent calls within 1000ms are throttled
+ * throttler.maybeExecute('123'); // Throttled
+ * ```
+ */
+declare class Throttler<TFn extends AnyFunction> {
+  #private;
+  fn: TFn;
+  readonly store: Store<Readonly<ThrottlerState<TFn>>>;
+  key: string | undefined;
+  options: ThrottlerOptions<TFn>;
+  constructor(fn: TFn, initialOptions: ThrottlerOptions<TFn>);
+  /**
+   * Updates the throttler options
+   */
+  setOptions: (newOptions: Partial<ThrottlerOptions<TFn>>) => void;
+  /**
+   * Attempts to execute the throttled function. The execution behavior depends on the throttler options:
+   *
+   * - If enough time has passed since the last execution (>= wait period):
+   *   - With leading=true: Executes immediately
+   *   - With leading=false: Waits for the next trailing execution
+   *
+   * - If within the wait period:
+   *   - With trailing=true: Schedules execution for end of wait period
+   *   - With trailing=false: Drops the execution
+   *
+   * @example
+   * ```ts
+   * const throttled = new Throttler(fn, { wait: 1000 });
+   *
+   * // First call executes immediately
+   * throttled.maybeExecute('a', 'b');
+   *
+   * // Call during wait period - gets throttled
+   * throttled.maybeExecute('c', 'd');
+   * ```
+   */
+  maybeExecute: (...args: Parameters<TFn>) => void;
+  /**
+   * Processes the current pending execution immediately
+   */
+  flush: () => void;
+  /**
+   * Cancels any pending trailing execution and clears internal state.
+   *
+   * If a trailing execution is scheduled (due to throttling with trailing=true),
+   * this will prevent that execution from occurring. The internal timeout and
+   * stored arguments will be cleared.
+   *
+   * Has no effect if there is no pending execution.
+   */
+  cancel: () => void;
+  /**
+   * Resets the throttler state to its default values
+   */
+  reset: () => void;
+}
+/**
+ * Creates a throttled function that limits how often the provided function can execute.
+ *
+ * This synchronous version is lighter weight and often all you need - upgrade to asyncThrottle when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+ *
+ * Throttling ensures a function executes at most once within a specified time window,
+ * regardless of how many times it is called. This is useful for rate-limiting
+ * expensive operations or UI updates.
+ *
+ * The throttled function can be configured to execute on the leading and/or trailing
+ * edge of the throttle window via options.
+ *
+ * For handling bursts of events, consider using debounce() instead. For hard execution
+ * limits, consider using rateLimit().
+ *
+ * State Management:
+ * - Uses TanStack Store for reactive state management
+ * - Use `initialState` to provide initial state values when creating the throttler
+ * - Use `onExecute` callback to react to function execution and implement custom logic
+ * - The state includes execution count, last execution time, pending status, and more
+ * - State can be accessed via the underlying Throttler instance's `store.state` property
+ * - When using framework adapters (React/Solid), state is accessed from the hook's state property
+ *
+ * @example
+ * ```ts
+ * // Basic throttling - max once per second
+ * const throttled = throttle(updateUI, { wait: 1000 });
+ *
+ * // Configure leading/trailing execution
+ * const throttled = throttle(saveData, {
+ *   wait: 2000,
+ *   leading: true,  // Execute immediately on first call
+ *   trailing: true  // Execute again after delay if called during wait
+ * });
+ * ```
+ */
+declare function throttle<TFn extends AnyFunction>(fn: TFn, initialOptions: ThrottlerOptions<TFn>): (...args: Parameters<TFn>) => void;
+//#endregion
+export { Throttler, ThrottlerOptions, ThrottlerState, throttle, throttlerOptions };
+//# sourceMappingURL=throttler.d.cts.map

package/dist/throttler.d.ts

@@ -0,0 +1,207 @@
+import { AnyFunction } from "./types.js";
+import { Store } from "@tanstack/store";
+
+//#region src/throttler.d.ts
+interface ThrottlerState<TFn extends AnyFunction> {
+  /**
+   * Number of function executions that have been completed
+   */
+  executionCount: number;
+  /**
+   * Whether the throttler is waiting for the timeout to trigger execution
+   */
+  isPending: boolean;
+  /**
+   * The arguments from the most recent call to maybeExecute
+   */
+  lastArgs: Parameters<TFn> | undefined;
+  /**
+   * Timestamp of the last function execution in milliseconds
+   */
+  lastExecutionTime: number;
+  /**
+   * Number of times maybeExecute has been called (for reduction calculations)
+   */
+  maybeExecuteCount: number;
+  /**
+   * Timestamp when the next execution can occur in milliseconds
+   */
+  nextExecutionTime: number | undefined;
+  /**
+   * Current execution status - 'idle' when not active, 'pending' when waiting for timeout
+   */
+  status: 'disabled' | 'idle' | 'pending';
+}
+/**
+ * Options for configuring a throttled function
+ */
+interface ThrottlerOptions<TFn extends AnyFunction> {
+  /**
+   * Whether the throttler 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 | ((throttler: Throttler<TFn>) => boolean);
+  /**
+   * Initial state for the throttler
+   */
+  initialState?: Partial<ThrottlerState<TFn>>;
+  /**
+   * A key to identify the throttler.
+   * If provided, the throttler 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.
+   * Defaults to true.
+   */
+  leading?: boolean;
+  /**
+   * Callback function that is called after the function is executed
+   */
+  onExecute?: (args: Parameters<TFn>, throttler: Throttler<TFn>) => void;
+  /**
+   * Whether to execute on the trailing edge of the timeout.
+   * Defaults to true.
+   */
+  trailing?: boolean;
+  /**
+   * Time window in milliseconds during which the function can only be executed once.
+   * Can be a number or a function that returns a number.
+   * Defaults to 0ms
+   */
+  wait: number | ((throttler: Throttler<TFn>) => number);
+}
+/**
+ * Utility function for sharing common `ThrottlerOptions` options between different `Throttler` instances.
+ */
+declare function throttlerOptions<TFn extends AnyFunction = AnyFunction, TOptions extends Partial<ThrottlerOptions<TFn>> = Partial<ThrottlerOptions<TFn>>>(options: TOptions): TOptions;
+/**
+ * A class that creates a throttled function.
+ *
+ * Throttling ensures a function is called at most once within a specified time window.
+ * Unlike debouncing which waits for a pause in calls, throttling guarantees consistent
+ * execution timing regardless of call frequency.
+ * This synchronous version is lighter weight and often all you need - upgrade to AsyncThrottler when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+ *
+ * Supports both leading and trailing edge execution:
+ * - Leading: Execute immediately on first call (default: true)
+ * - Trailing: Execute after wait period if called during throttle (default: true)
+ *
+ * For collapsing rapid-fire events where you only care about the last call, consider using Debouncer.
+ *
+ * State Management:
+ * - Uses TanStack Store for reactive state management
+ * - Use `initialState` to provide initial state values when creating the throttler
+ * - Use `onExecute` callback to react to function execution and implement custom logic
+ * - The state includes execution count, last execution time, pending status, and more
+ * - State can be accessed via `throttler.store.state` when using the class directly
+ * - When using framework adapters (React/Solid), state is accessed from `throttler.state`
+ *
+ * @example
+ * ```ts
+ * const throttler = new Throttler(
+ *   (id: string) => api.getData(id),
+ *   { wait: 1000 } // Execute at most once per second
+ * );
+ *
+ * // First call executes immediately
+ * throttler.maybeExecute('123');
+ *
+ * // Subsequent calls within 1000ms are throttled
+ * throttler.maybeExecute('123'); // Throttled
+ * ```
+ */
+declare class Throttler<TFn extends AnyFunction> {
+  #private;
+  fn: TFn;
+  readonly store: Store<Readonly<ThrottlerState<TFn>>>;
+  key: string | undefined;
+  options: ThrottlerOptions<TFn>;
+  constructor(fn: TFn, initialOptions: ThrottlerOptions<TFn>);
+  /**
+   * Updates the throttler options
+   */
+  setOptions: (newOptions: Partial<ThrottlerOptions<TFn>>) => void;
+  /**
+   * Attempts to execute the throttled function. The execution behavior depends on the throttler options:
+   *
+   * - If enough time has passed since the last execution (>= wait period):
+   *   - With leading=true: Executes immediately
+   *   - With leading=false: Waits for the next trailing execution
+   *
+   * - If within the wait period:
+   *   - With trailing=true: Schedules execution for end of wait period
+   *   - With trailing=false: Drops the execution
+   *
+   * @example
+   * ```ts
+   * const throttled = new Throttler(fn, { wait: 1000 });
+   *
+   * // First call executes immediately
+   * throttled.maybeExecute('a', 'b');
+   *
+   * // Call during wait period - gets throttled
+   * throttled.maybeExecute('c', 'd');
+   * ```
+   */
+  maybeExecute: (...args: Parameters<TFn>) => void;
+  /**
+   * Processes the current pending execution immediately
+   */
+  flush: () => void;
+  /**
+   * Cancels any pending trailing execution and clears internal state.
+   *
+   * If a trailing execution is scheduled (due to throttling with trailing=true),
+   * this will prevent that execution from occurring. The internal timeout and
+   * stored arguments will be cleared.
+   *
+   * Has no effect if there is no pending execution.
+   */
+  cancel: () => void;
+  /**
+   * Resets the throttler state to its default values
+   */
+  reset: () => void;
+}
+/**
+ * Creates a throttled function that limits how often the provided function can execute.
+ *
+ * This synchronous version is lighter weight and often all you need - upgrade to asyncThrottle when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+ *
+ * Throttling ensures a function executes at most once within a specified time window,
+ * regardless of how many times it is called. This is useful for rate-limiting
+ * expensive operations or UI updates.
+ *
+ * The throttled function can be configured to execute on the leading and/or trailing
+ * edge of the throttle window via options.
+ *
+ * For handling bursts of events, consider using debounce() instead. For hard execution
+ * limits, consider using rateLimit().
+ *
+ * State Management:
+ * - Uses TanStack Store for reactive state management
+ * - Use `initialState` to provide initial state values when creating the throttler
+ * - Use `onExecute` callback to react to function execution and implement custom logic
+ * - The state includes execution count, last execution time, pending status, and more
+ * - State can be accessed via the underlying Throttler instance's `store.state` property
+ * - When using framework adapters (React/Solid), state is accessed from the hook's state property
+ *
+ * @example
+ * ```ts
+ * // Basic throttling - max once per second
+ * const throttled = throttle(updateUI, { wait: 1000 });
+ *
+ * // Configure leading/trailing execution
+ * const throttled = throttle(saveData, {
+ *   wait: 2000,
+ *   leading: true,  // Execute immediately on first call
+ *   trailing: true  // Execute again after delay if called during wait
+ * });
+ * ```
+ */
+declare function throttle<TFn extends AnyFunction>(fn: TFn, initialOptions: ThrottlerOptions<TFn>): (...args: Parameters<TFn>) => void;
+//#endregion
+export { Throttler, ThrottlerOptions, ThrottlerState, throttle, throttlerOptions };
+//# sourceMappingURL=throttler.d.ts.map