@tanstack/pacer 0.16.2 → 0.16.4

package/dist/rate-limiter.cjs

@@ -0,0 +1,251 @@
+const require_utils = require('./utils.cjs');
+const require_event_client = require('./event-client.cjs');
+let __tanstack_store = require("@tanstack/store");
+
+//#region src/rate-limiter.ts
+function getDefaultRateLimiterState() {
+	return {
+		executionCount: 0,
+		executionTimes: [],
+		isExceeded: false,
+		rejectionCount: 0,
+		status: "idle",
+		maybeExecuteCount: 0
+	};
+}
+/**
+* Utility function for sharing common `RateLimiterOptions` options between different `RateLimiter` instances.
+*/
+function rateLimiterOptions(options) {
+	return options;
+}
+const defaultOptions = {
+	enabled: true,
+	limit: 1,
+	window: 0,
+	windowType: "fixed"
+};
+/**
+* A class that creates a rate-limited function.
+*
+* Rate limiting is a simple approach that allows a function to execute up to a limit within a time window,
+* then blocks all subsequent calls until the window passes. This can lead to "bursty" behavior where
+* all executions happen immediately, followed by a complete block.
+* This synchronous version is lighter weight and often all you need - upgrade to AsyncRateLimiter when you need promises, retry support, abort capabilities, or advanced error handling.
+*
+* The rate limiter supports two types of windows:
+* - 'fixed': A strict window that resets after the window period. All executions within the window count
+*   towards the limit, and the window resets completely after the period.
+* - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
+*   consistent rate of execution over time.
+*
+* For smoother execution patterns, consider using:
+* - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)
+* - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)
+*
+* Rate limiting is best used for hard API limits or resource constraints. For UI updates or
+* smoothing out frequent events, throttling or debouncing usually provide better user experience.
+*
+* State Management:
+* - Uses TanStack Store for reactive state management
+* - Use `initialState` to provide initial state values when creating the rate limiter
+* - Use `onExecute` callback to react to function execution and implement custom logic
+* - Use `onReject` callback to react to executions being rejected when rate limit is exceeded
+* - The state includes execution count, execution times, and rejection count
+* - State can be accessed via `rateLimiter.store.state` when using the class directly
+* - When using framework adapters (React/Solid), state is accessed from `rateLimiter.state`
+*
+* @example
+* ```ts
+* const rateLimiter = new RateLimiter(
+*   (id: string) => api.getData(id),
+*   {
+*     limit: 5,
+*     window: 1000,
+*     windowType: 'sliding',
+*   }
+* );
+*
+* // Will execute immediately until limit reached, then block
+* rateLimiter.maybeExecute('123');
+* ```
+*/
+var RateLimiter = class {
+	#timeoutIds = /* @__PURE__ */ new Set();
+	constructor(fn, initialOptions) {
+		this.fn = fn;
+		this.store = new __tanstack_store.Store(getDefaultRateLimiterState());
+		this.setOptions = (newOptions) => {
+			this.options = {
+				...this.options,
+				...newOptions
+			};
+		};
+		this.maybeExecute = (...args) => {
+			this.#setState({ maybeExecuteCount: this.store.state.maybeExecuteCount + 1 });
+			this.#cleanupOldExecutions();
+			if (this.#getExecutionTimesInWindow().length < this.#getLimit()) {
+				this.#execute(...args);
+				return true;
+			}
+			this.#setState({ rejectionCount: this.store.state.rejectionCount + 1 });
+			this.options.onReject?.(this);
+			return false;
+		};
+		this.getRemainingInWindow = () => {
+			const relevantExecutionTimes = this.#getExecutionTimesInWindow();
+			return Math.max(0, this.#getLimit() - relevantExecutionTimes.length);
+		};
+		this.getMsUntilNextWindow = () => {
+			if (this.getRemainingInWindow() > 0) return 0;
+			return (this.store.state.executionTimes[0] ?? Infinity) + this.#getWindow() - Date.now();
+		};
+		this.reset = () => {
+			this.#setState(getDefaultRateLimiterState());
+			this.#clearTimeouts();
+		};
+		this.key = initialOptions.key;
+		this.options = {
+			...defaultOptions,
+			...initialOptions
+		};
+		this.#setState(this.options.initialState ?? {});
+		for (const executionTime of this.#getExecutionTimesInWindow()) this.#setCleanupTimeout(executionTime);
+		if (this.key) require_event_client.pacerEventClient.on("d-RateLimiter", (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 isExceeded = combinedState.executionTimes.length >= this.#getLimit();
+			const status = !this.#getEnabled() ? "disabled" : isExceeded ? "exceeded" : "idle";
+			return {
+				...combinedState,
+				isExceeded,
+				status
+			};
+		});
+		require_event_client.emitChange("RateLimiter", this);
+	};
+	/**
+	* Returns the current enabled state of the rate limiter
+	*/
+	#getEnabled = () => {
+		return !!require_utils.parseFunctionOrValue(this.options.enabled, this);
+	};
+	/**
+	* Returns the current limit of executions allowed within the time window
+	*/
+	#getLimit = () => {
+		return require_utils.parseFunctionOrValue(this.options.limit, this);
+	};
+	/**
+	* Returns the current time window in milliseconds
+	*/
+	#getWindow = () => {
+		return require_utils.parseFunctionOrValue(this.options.window, this);
+	};
+	#execute = (...args) => {
+		if (!this.#getEnabled()) return;
+		const now = Date.now();
+		this.fn(...args);
+		this.store.state.executionTimes.push(now);
+		this.#setCleanupTimeout(now);
+		this.#setState({ executionCount: this.store.state.executionCount + 1 });
+		this.options.onExecute?.(args, this);
+	};
+	#getExecutionTimesInWindow = () => {
+		if (this.options.windowType === "sliding") return this.store.state.executionTimes.filter((time) => time > Date.now() - this.#getWindow());
+		else {
+			if (this.store.state.executionTimes.length === 0) return [];
+			const windowStart = Math.min(...this.store.state.executionTimes);
+			const windowEnd = windowStart + this.#getWindow();
+			if (Date.now() > windowEnd) return [];
+			return this.store.state.executionTimes.filter((time) => time >= windowStart && time <= windowEnd);
+		}
+	};
+	#setCleanupTimeout = (executionTime) => {
+		if (this.options.windowType === "sliding" || this.#timeoutIds.size === 0) {
+			const timeUntilExpiration = executionTime - Date.now() + this.#getWindow() + 1;
+			const timeoutId = setTimeout(() => {
+				this.#cleanupOldExecutions();
+				this.#clearTimeout(timeoutId);
+			}, timeUntilExpiration);
+			this.#timeoutIds.add(timeoutId);
+		}
+	};
+	#clearTimeout = (timeoutId) => {
+		clearTimeout(timeoutId);
+		this.#timeoutIds.delete(timeoutId);
+	};
+	#clearTimeouts = () => {
+		this.#timeoutIds.forEach((timeoutId) => clearTimeout(timeoutId));
+		this.#timeoutIds.clear();
+	};
+	#cleanupOldExecutions = () => {
+		this.#setState({ executionTimes: this.#getExecutionTimesInWindow() });
+	};
+};
+/**
+* Creates a rate-limited function that will execute the provided function up to a maximum number of times within a time window.
+*
+* This synchronous version is lighter weight and often all you need - upgrade to asyncRateLimit when you need promises, retry support, abort capabilities, or advanced error handling.
+*
+* Note that rate limiting is a simpler form of execution control compared to throttling or debouncing:
+* - A rate limiter will allow all executions until the limit is reached, then block all subsequent calls until the window resets
+* - A throttler ensures even spacing between executions, which can be better for consistent performance
+* - A debouncer collapses multiple calls into one, which is better for handling bursts of events
+*
+* The rate limiter supports two types of windows:
+* - 'fixed': A strict window that resets after the window period. All executions within the window count
+*   towards the limit, and the window resets completely after the period.
+* - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
+*   consistent rate of execution over time.
+*
+* State Management:
+* - Uses TanStack Store for reactive state management
+* - Use `initialState` to provide initial state values when creating the rate limiter
+* - Use `onExecute` callback to react to function execution and implement custom logic
+* - Use `onReject` callback to react to executions being rejected when rate limit is exceeded
+* - The state includes execution count, execution times, and rejection count
+* - State can be accessed via the underlying RateLimiter instance's `store.state` property
+* - When using framework adapters (React/Solid), state is accessed from the hook's state property
+*
+* Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically
+* need to enforce a hard limit on the number of executions within a time period.
+*
+* @example
+* ```ts
+* // Rate limit to 5 calls per minute with a sliding window
+* const rateLimited = rateLimit(makeApiCall, {
+*   limit: 5,
+*   window: 60000,
+*   windowType: 'sliding',
+*   onReject: (rateLimiter) => {
+*     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
+*   }
+* });
+*
+* // First 5 calls will execute immediately
+* // Additional calls will be rejected until the minute window resets
+* rateLimited();
+*
+* // For more even execution, consider using throttle instead:
+* const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
+* ```
+*/
+function rateLimit(fn, initialOptions) {
+	return new RateLimiter(fn, initialOptions).maybeExecute;
+}
+
+//#endregion
+exports.RateLimiter = RateLimiter;
+exports.rateLimit = rateLimit;
+exports.rateLimiterOptions = rateLimiterOptions;
+//# sourceMappingURL=rate-limiter.cjs.map

package/dist/rate-limiter.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter.cjs","names":["defaultOptions: Omit<\n  Required<RateLimiterOptions<any>>,\n  'initialState' | 'onExecute' | 'onReject' | 'key'\n>","fn: TFn","Store","#setState","#cleanupOldExecutions","#getExecutionTimesInWindow","#getLimit","#execute","#getWindow","#clearTimeouts","#setCleanupTimeout","#getEnabled","parseFunctionOrValue","#timeoutIds","#clearTimeout"],"sources":["../src/rate-limiter.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 RateLimiterState {\n  /**\n   * Number of function executions that have been completed\n   */\n  executionCount: number\n  /**\n   * Array of timestamps when executions occurred for rate limiting calculations\n   */\n  executionTimes: Array<number>\n  /**\n   * Whether the rate limiter has exceeded the limit\n   */\n  isExceeded: boolean\n  /**\n   * Number of times maybeExecute has been called (for reduction calculations)\n   */\n  maybeExecuteCount: number\n  /**\n   * Number of function executions that have been rejected due to rate limiting\n   */\n  rejectionCount: number\n  /**\n   * Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded\n   */\n  status: 'disabled' | 'exceeded' | 'idle'\n}\n\nfunction getDefaultRateLimiterState(): RateLimiterState {\n  return {\n    executionCount: 0,\n    executionTimes: [],\n    isExceeded: false,\n    rejectionCount: 0,\n    status: 'idle',\n    maybeExecuteCount: 0,\n  }\n}\n\n/**\n * Options for configuring a rate-limited function\n */\nexport interface RateLimiterOptions<TFn extends AnyFunction> {\n  /**\n   * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean | ((rateLimiter: RateLimiter<TFn>) => boolean)\n  /**\n   * Initial state for the rate limiter\n   */\n  initialState?: Partial<RateLimiterState>\n  /**\n   * Optional key to identify this rate limiter instance.\n   * If provided, the rate limiter will be identified by this key in the devtools and PacerProvider if applicable.\n   */\n  key?: string\n  /**\n   * Maximum number of executions allowed within the time window.\n   * Can be a number or a callback function that receives the rate limiter instance and returns a number.\n   */\n  limit: number | ((rateLimiter: RateLimiter<TFn>) => number)\n  /**\n   * Callback function that is called after the function is executed\n   */\n  onExecute?: (args: Parameters<TFn>, rateLimiter: RateLimiter<TFn>) => void\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (rateLimiter: RateLimiter<TFn>) => void\n  /**\n   * Time window in milliseconds within which the limit applies.\n   * Can be a number or a callback function that receives the rate limiter instance and returns a number.\n   */\n  window: number | ((rateLimiter: RateLimiter<TFn>) => number)\n  /**\n   * Type of window to use for rate limiting\n   * - 'fixed': Uses a fixed window that resets after the window period\n   * - 'sliding': Uses a sliding window that allows executions as old ones expire\n   * Defaults to 'fixed'\n   */\n  windowType?: 'fixed' | 'sliding'\n}\n\n/**\n * Utility function for sharing common `RateLimiterOptions` options between different `RateLimiter` instances.\n */\nexport function rateLimiterOptions<\n  TFn extends AnyFunction = AnyFunction,\n  TOptions extends Partial<RateLimiterOptions<TFn>> = Partial<\n    RateLimiterOptions<TFn>\n  >,\n>(options: TOptions): TOptions {\n  return options\n}\n\nconst defaultOptions: Omit<\n  Required<RateLimiterOptions<any>>,\n  'initialState' | 'onExecute' | 'onReject' | 'key'\n> = {\n  enabled: true,\n  limit: 1,\n  window: 0,\n  windowType: 'fixed',\n}\n\n/**\n * A class that creates a rate-limited function.\n *\n * Rate limiting is a simple approach that allows a function to execute up to a limit within a time window,\n * then blocks all subsequent calls until the window passes. This can lead to \"bursty\" behavior where\n * all executions happen immediately, followed by a complete block.\n * This synchronous version is lighter weight and often all you need - upgrade to AsyncRateLimiter when you need promises, retry support, abort capabilities, or advanced error handling.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * For smoother execution patterns, consider using:\n * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)\n * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)\n *\n * Rate limiting is best used for hard API limits or resource constraints. For UI updates or\n * smoothing out frequent events, throttling or debouncing usually provide better user experience.\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the rate limiter\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution count, execution times, and rejection count\n * - State can be accessed via `rateLimiter.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `rateLimiter.state`\n *\n * @example\n * ```ts\n * const rateLimiter = new RateLimiter(\n *   (id: string) => api.getData(id),\n *   {\n *     limit: 5,\n *     window: 1000,\n *     windowType: 'sliding',\n *   }\n * );\n *\n * // Will execute immediately until limit reached, then block\n * rateLimiter.maybeExecute('123');\n * ```\n */\nexport class RateLimiter<TFn extends AnyFunction> {\n  readonly store: Store<Readonly<RateLimiterState>> =\n    new Store<RateLimiterState>(getDefaultRateLimiterState())\n  key: string | undefined\n  options: RateLimiterOptions<TFn>\n  #timeoutIds: Set<NodeJS.Timeout> = new Set()\n\n  constructor(\n    public fn: TFn,\n    initialOptions: RateLimiterOptions<TFn>,\n  ) {\n    this.key = initialOptions.key\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n    this.#setState(this.options.initialState ?? {})\n    for (const executionTime of this.#getExecutionTimesInWindow()) {\n      this.#setCleanupTimeout(executionTime)\n    }\n\n    if (this.key) {\n      pacerEventClient.on('d-RateLimiter', (event) => {\n        if (event.payload.key !== this.key) return\n        this.#setState(event.payload.store.state)\n        this.setOptions(event.payload.options)\n      })\n    }\n  }\n\n  /**\n   * Updates the rate limiter options\n   */\n  setOptions = (newOptions: Partial<RateLimiterOptions<TFn>>): void => {\n    this.options = { ...this.options, ...newOptions }\n  }\n\n  #setState = (newState: Partial<RateLimiterState>): void => {\n    this.store.setState((state) => {\n      const combinedState = {\n        ...state,\n        ...newState,\n      }\n      const isExceeded = combinedState.executionTimes.length >= this.#getLimit()\n      const status = !this.#getEnabled()\n        ? 'disabled'\n        : isExceeded\n          ? 'exceeded'\n          : 'idle'\n      return {\n        ...combinedState,\n        isExceeded,\n        status,\n      }\n    })\n    emitChange('RateLimiter', this)\n  }\n\n  /**\n   * Returns the current enabled state of the rate limiter\n   */\n  #getEnabled = (): boolean => {\n    return !!parseFunctionOrValue(this.options.enabled, this)\n  }\n\n  /**\n   * Returns the current limit of executions allowed within the time window\n   */\n  #getLimit = (): number => {\n    return parseFunctionOrValue(this.options.limit, this)\n  }\n\n  /**\n   * Returns the current time window in milliseconds\n   */\n  #getWindow = (): number => {\n    return parseFunctionOrValue(this.options.window, this)\n  }\n\n  /**\n   * Attempts to execute the rate-limited function if within the configured limits.\n   * Will reject execution if the number of calls in the current window exceeds the limit.\n   *\n   * @example\n   * ```ts\n   * const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will return true\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // true\n   *\n   * // Additional calls within the window will return false\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // false\n   * ```\n   */\n  maybeExecute = (...args: Parameters<TFn>): boolean => {\n    this.#setState({\n      maybeExecuteCount: this.store.state.maybeExecuteCount + 1,\n    })\n\n    this.#cleanupOldExecutions()\n\n    const relevantExecutionTimes = this.#getExecutionTimesInWindow()\n\n    if (relevantExecutionTimes.length < this.#getLimit()) {\n      this.#execute(...args)\n      return true\n    }\n\n    this.#setState({\n      rejectionCount: this.store.state.rejectionCount + 1,\n    })\n    this.options.onReject?.(this)\n    return false\n  }\n\n  #execute = (...args: Parameters<TFn>): void => {\n    if (!this.#getEnabled()) return\n    const now = Date.now()\n    this.fn(...args) // EXECUTE!\n    this.store.state.executionTimes.push(now) // mutate state directly for performance\n\n    this.#setCleanupTimeout(now)\n\n    this.#setState({\n      executionCount: this.store.state.executionCount + 1,\n    })\n    this.options.onExecute?.(args, this)\n  }\n\n  #getExecutionTimesInWindow = (): Array<number> => {\n    if (this.options.windowType === 'sliding') {\n      // For sliding window, return all executions within the current window\n      return this.store.state.executionTimes.filter(\n        (time) => time > Date.now() - this.#getWindow(),\n      )\n    } else {\n      // For fixed window, return all executions in the current window\n      // The window starts from the oldest execution time\n      if (this.store.state.executionTimes.length === 0) {\n        return []\n      }\n      const oldestExecution = Math.min(...this.store.state.executionTimes)\n      const windowStart = oldestExecution\n      const windowEnd = windowStart + this.#getWindow()\n      const now = Date.now()\n\n      // If the window has expired, return empty array\n      if (now > windowEnd) {\n        return []\n      }\n\n      // Otherwise, return all executions in the current window\n      return this.store.state.executionTimes.filter(\n        (time) => time >= windowStart && time <= windowEnd,\n      )\n    }\n  }\n\n  #setCleanupTimeout = (executionTime: number): void => {\n    if (\n      this.options.windowType === 'sliding' ||\n      this.#timeoutIds.size === 0 // new fixed window\n    ) {\n      const now = Date.now()\n      const timeUntilExpiration = executionTime - now + this.#getWindow() + 1\n      const timeoutId = setTimeout(() => {\n        this.#cleanupOldExecutions()\n        this.#clearTimeout(timeoutId)\n      }, timeUntilExpiration)\n      this.#timeoutIds.add(timeoutId)\n    }\n  }\n\n  #clearTimeout = (timeoutId: NodeJS.Timeout): void => {\n    clearTimeout(timeoutId)\n    this.#timeoutIds.delete(timeoutId)\n  }\n\n  #clearTimeouts = (): void => {\n    this.#timeoutIds.forEach((timeoutId) => clearTimeout(timeoutId))\n    this.#timeoutIds.clear()\n  }\n\n  #cleanupOldExecutions = (): void => {\n    this.#setState({\n      executionTimes: this.#getExecutionTimesInWindow(),\n    })\n  }\n\n  /**\n   * Returns the number of remaining executions allowed in the current window\n   */\n  getRemainingInWindow = (): number => {\n    const relevantExecutionTimes = this.#getExecutionTimesInWindow()\n    return Math.max(0, this.#getLimit() - relevantExecutionTimes.length)\n  }\n\n  /**\n   * Returns the number of milliseconds until the next execution will be possible\n   */\n  getMsUntilNextWindow = (): number => {\n    if (this.getRemainingInWindow() > 0) {\n      return 0\n    }\n    const oldestExecution = this.store.state.executionTimes[0] ?? Infinity\n    return oldestExecution + this.#getWindow() - Date.now()\n  }\n\n  /**\n   * Resets the rate limiter state\n   */\n  reset = (): void => {\n    this.#setState(getDefaultRateLimiterState())\n    this.#clearTimeouts()\n  }\n}\n\n/**\n * Creates a rate-limited function that will execute the provided function up to a maximum number of times within a time window.\n *\n * This synchronous version is lighter weight and often all you need - upgrade to asyncRateLimit when you need promises, retry support, abort capabilities, or advanced error handling.\n *\n * Note that rate limiting is a simpler form of execution control compared to throttling or debouncing:\n * - A rate limiter will allow all executions until the limit is reached, then block all subsequent calls until the window resets\n * - A throttler ensures even spacing between executions, which can be better for consistent performance\n * - A debouncer collapses multiple calls into one, which is better for handling bursts of events\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the rate limiter\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution count, execution times, and rejection count\n * - State can be accessed via the underlying RateLimiter instance's `store.state` property\n * - When using framework adapters (React/Solid), state is accessed from the hook's state property\n *\n * Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically\n * need to enforce a hard limit on the number of executions within a time period.\n *\n * @example\n * ```ts\n * // Rate limit to 5 calls per minute with a sliding window\n * const rateLimited = rateLimit(makeApiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\n *   onReject: (rateLimiter) => {\n *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // First 5 calls will execute immediately\n * // Additional calls will be rejected until the minute window resets\n * rateLimited();\n *\n * // For more even execution, consider using throttle instead:\n * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds\n * ```\n */\nexport function rateLimit<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn>,\n) {\n  const rateLimiter = new RateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute\n}\n"],"mappings":";;;;;AAgCA,SAAS,6BAA+C;AACtD,QAAO;EACL,gBAAgB;EAChB,gBAAgB,EAAE;EAClB,YAAY;EACZ,gBAAgB;EAChB,QAAQ;EACR,mBAAmB;EACpB;;;;;AAmDH,SAAgB,mBAKd,SAA6B;AAC7B,QAAO;;AAGT,MAAMA,iBAGF;CACF,SAAS;CACT,OAAO;CACP,QAAQ;CACR,YAAY;CACb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CD,IAAa,cAAb,MAAkD;CAKhD,8BAAmC,IAAI,KAAK;CAE5C,YACE,AAAOC,IACP,gBACA;EAFO;eANP,IAAIC,uBAAwB,4BAA4B,CAAC;qBA+B7C,eAAuD;AACnE,QAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;IAAY;;uBA4DnC,GAAG,SAAmC;AACpD,SAAKC,SAAU,EACb,mBAAmB,KAAK,MAAM,MAAM,oBAAoB,GACzD,CAAC;AAEF,SAAKC,sBAAuB;AAI5B,OAF+B,MAAKC,2BAA4B,CAErC,SAAS,MAAKC,UAAW,EAAE;AACpD,UAAKC,QAAS,GAAG,KAAK;AACtB,WAAO;;AAGT,SAAKJ,SAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,GACnD,CAAC;AACF,QAAK,QAAQ,WAAW,KAAK;AAC7B,UAAO;;oCAgF4B;GACnC,MAAM,yBAAyB,MAAKE,2BAA4B;AAChE,UAAO,KAAK,IAAI,GAAG,MAAKC,UAAW,GAAG,uBAAuB,OAAO;;oCAMjC;AACnC,OAAI,KAAK,sBAAsB,GAAG,EAChC,QAAO;AAGT,WADwB,KAAK,MAAM,MAAM,eAAe,MAAM,YACrC,MAAKE,WAAY,GAAG,KAAK,KAAK;;qBAMrC;AAClB,SAAKL,SAAU,4BAA4B,CAAC;AAC5C,SAAKM,eAAgB;;AA1MrB,OAAK,MAAM,eAAe;AAC1B,OAAK,UAAU;GACb,GAAG;GACH,GAAG;GACJ;AACD,QAAKN,SAAU,KAAK,QAAQ,gBAAgB,EAAE,CAAC;AAC/C,OAAK,MAAM,iBAAiB,MAAKE,2BAA4B,CAC3D,OAAKK,kBAAmB,cAAc;AAGxC,MAAI,KAAK,IACP,uCAAiB,GAAG,kBAAkB,UAAU;AAC9C,OAAI,MAAM,QAAQ,QAAQ,KAAK,IAAK;AACpC,SAAKP,SAAU,MAAM,QAAQ,MAAM,MAAM;AACzC,QAAK,WAAW,MAAM,QAAQ,QAAQ;IACtC;;CAWN,aAAa,aAA8C;AACzD,OAAK,MAAM,UAAU,UAAU;GAC7B,MAAM,gBAAgB;IACpB,GAAG;IACH,GAAG;IACJ;GACD,MAAM,aAAa,cAAc,eAAe,UAAU,MAAKG,UAAW;GAC1E,MAAM,SAAS,CAAC,MAAKK,YAAa,GAC9B,aACA,aACE,aACA;AACN,UAAO;IACL,GAAG;IACH;IACA;IACD;IACD;AACF,kCAAW,eAAe,KAAK;;;;;CAMjC,oBAA6B;AAC3B,SAAO,CAAC,CAACC,mCAAqB,KAAK,QAAQ,SAAS,KAAK;;;;;CAM3D,kBAA0B;AACxB,SAAOA,mCAAqB,KAAK,QAAQ,OAAO,KAAK;;;;;CAMvD,mBAA2B;AACzB,SAAOA,mCAAqB,KAAK,QAAQ,QAAQ,KAAK;;CAuCxD,YAAY,GAAG,SAAgC;AAC7C,MAAI,CAAC,MAAKD,YAAa,CAAE;EACzB,MAAM,MAAM,KAAK,KAAK;AACtB,OAAK,GAAG,GAAG,KAAK;AAChB,OAAK,MAAM,MAAM,eAAe,KAAK,IAAI;AAEzC,QAAKD,kBAAmB,IAAI;AAE5B,QAAKP,SAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,GACnD,CAAC;AACF,OAAK,QAAQ,YAAY,MAAM,KAAK;;CAGtC,mCAAkD;AAChD,MAAI,KAAK,QAAQ,eAAe,UAE9B,QAAO,KAAK,MAAM,MAAM,eAAe,QACpC,SAAS,OAAO,KAAK,KAAK,GAAG,MAAKK,WAAY,CAChD;OACI;AAGL,OAAI,KAAK,MAAM,MAAM,eAAe,WAAW,EAC7C,QAAO,EAAE;GAGX,MAAM,cADkB,KAAK,IAAI,GAAG,KAAK,MAAM,MAAM,eAAe;GAEpE,MAAM,YAAY,cAAc,MAAKA,WAAY;AAIjD,OAHY,KAAK,KAAK,GAGZ,UACR,QAAO,EAAE;AAIX,UAAO,KAAK,MAAM,MAAM,eAAe,QACpC,SAAS,QAAQ,eAAe,QAAQ,UAC1C;;;CAIL,sBAAsB,kBAAgC;AACpD,MACE,KAAK,QAAQ,eAAe,aAC5B,MAAKK,WAAY,SAAS,GAC1B;GAEA,MAAM,sBAAsB,gBADhB,KAAK,KAAK,GAC4B,MAAKL,WAAY,GAAG;GACtE,MAAM,YAAY,iBAAiB;AACjC,UAAKJ,sBAAuB;AAC5B,UAAKU,aAAc,UAAU;MAC5B,oBAAoB;AACvB,SAAKD,WAAY,IAAI,UAAU;;;CAInC,iBAAiB,cAAoC;AACnD,eAAa,UAAU;AACvB,QAAKA,WAAY,OAAO,UAAU;;CAGpC,uBAA6B;AAC3B,QAAKA,WAAY,SAAS,cAAc,aAAa,UAAU,CAAC;AAChE,QAAKA,WAAY,OAAO;;CAG1B,8BAAoC;AAClC,QAAKV,SAAU,EACb,gBAAgB,MAAKE,2BAA4B,EAClD,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+EN,SAAgB,UACd,IACA,gBACA;AAEA,QADoB,IAAI,YAAY,IAAI,eAAe,CACpC"}

package/dist/{cjs/rate-limiter.d.cts → rate-limiter.d.cts}

@@ -1,79 +1,81 @@
-import { Store } from '@tanstack/store';
-import { AnyFunction } from './types.cjs';
-export interface RateLimiterState {
-    /**
-     * Number of function executions that have been completed
-     */
-    executionCount: number;
-    /**
-     * Array of timestamps when executions occurred for rate limiting calculations
-     */
-    executionTimes: Array<number>;
-    /**
-     * Whether the rate limiter has exceeded the limit
-     */
-    isExceeded: boolean;
-    /**
-     * Number of times maybeExecute has been called (for reduction calculations)
-     */
-    maybeExecuteCount: number;
-    /**
-     * Number of function executions that have been rejected due to rate limiting
-     */
-    rejectionCount: number;
-    /**
-     * Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded
-     */
-    status: 'disabled' | 'exceeded' | 'idle';
+import { AnyFunction } from "./types.cjs";
+import { Store } from "@tanstack/store";
+
+//#region src/rate-limiter.d.ts
+interface RateLimiterState {
+  /**
+   * Number of function executions that have been completed
+   */
+  executionCount: number;
+  /**
+   * Array of timestamps when executions occurred for rate limiting calculations
+   */
+  executionTimes: Array<number>;
+  /**
+   * Whether the rate limiter has exceeded the limit
+   */
+  isExceeded: boolean;
+  /**
+   * Number of times maybeExecute has been called (for reduction calculations)
+   */
+  maybeExecuteCount: number;
+  /**
+   * Number of function executions that have been rejected due to rate limiting
+   */
+  rejectionCount: number;
+  /**
+   * Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded
+   */
+  status: 'disabled' | 'exceeded' | 'idle';
 }
 /**
  * Options for configuring a rate-limited function
  */
-export interface RateLimiterOptions<TFn extends AnyFunction> {
-    /**
-     * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.
-     * Defaults to true.
-     */
-    enabled?: boolean | ((rateLimiter: RateLimiter<TFn>) => boolean);
-    /**
-     * Initial state for the rate limiter
-     */
-    initialState?: Partial<RateLimiterState>;
-    /**
-     * Optional key to identify this rate limiter instance.
-     * If provided, the rate limiter will be identified by this key in the devtools and PacerProvider if applicable.
-     */
-    key?: string;
-    /**
-     * Maximum number of executions allowed within the time window.
-     * Can be a number or a callback function that receives the rate limiter instance and returns a number.
-     */
-    limit: number | ((rateLimiter: RateLimiter<TFn>) => number);
-    /**
-     * Callback function that is called after the function is executed
-     */
-    onExecute?: (args: Parameters<TFn>, rateLimiter: RateLimiter<TFn>) => void;
-    /**
-     * Optional callback function that is called when an execution is rejected due to rate limiting
-     */
-    onReject?: (rateLimiter: RateLimiter<TFn>) => void;
-    /**
-     * Time window in milliseconds within which the limit applies.
-     * Can be a number or a callback function that receives the rate limiter instance and returns a number.
-     */
-    window: number | ((rateLimiter: RateLimiter<TFn>) => number);
-    /**
-     * Type of window to use for rate limiting
-     * - 'fixed': Uses a fixed window that resets after the window period
-     * - 'sliding': Uses a sliding window that allows executions as old ones expire
-     * Defaults to 'fixed'
-     */
-    windowType?: 'fixed' | 'sliding';
+interface RateLimiterOptions<TFn extends AnyFunction> {
+  /**
+   * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.
+   * Defaults to true.
+   */
+  enabled?: boolean | ((rateLimiter: RateLimiter<TFn>) => boolean);
+  /**
+   * Initial state for the rate limiter
+   */
+  initialState?: Partial<RateLimiterState>;
+  /**
+   * Optional key to identify this rate limiter instance.
+   * If provided, the rate limiter will be identified by this key in the devtools and PacerProvider if applicable.
+   */
+  key?: string;
+  /**
+   * Maximum number of executions allowed within the time window.
+   * Can be a number or a callback function that receives the rate limiter instance and returns a number.
+   */
+  limit: number | ((rateLimiter: RateLimiter<TFn>) => number);
+  /**
+   * Callback function that is called after the function is executed
+   */
+  onExecute?: (args: Parameters<TFn>, rateLimiter: RateLimiter<TFn>) => void;
+  /**
+   * Optional callback function that is called when an execution is rejected due to rate limiting
+   */
+  onReject?: (rateLimiter: RateLimiter<TFn>) => void;
+  /**
+   * Time window in milliseconds within which the limit applies.
+   * Can be a number or a callback function that receives the rate limiter instance and returns a number.
+   */
+  window: number | ((rateLimiter: RateLimiter<TFn>) => number);
+  /**
+   * Type of window to use for rate limiting
+   * - 'fixed': Uses a fixed window that resets after the window period
+   * - 'sliding': Uses a sliding window that allows executions as old ones expire
+   * Defaults to 'fixed'
+   */
+  windowType?: 'fixed' | 'sliding';
 }
 /**
  * Utility function for sharing common `RateLimiterOptions` options between different `RateLimiter` instances.
  */
-export declare function rateLimiterOptions<TFn extends AnyFunction = AnyFunction, TOptions extends Partial<RateLimiterOptions<TFn>> = Partial<RateLimiterOptions<TFn>>>(options: TOptions): TOptions;
+declare function rateLimiterOptions<TFn extends AnyFunction = AnyFunction, TOptions extends Partial<RateLimiterOptions<TFn>> = Partial<RateLimiterOptions<TFn>>>(options: TOptions): TOptions;
 /**
  * A class that creates a rate-limited function.
  *
@@ -119,45 +121,45 @@ export declare function rateLimiterOptions<TFn extends AnyFunction = AnyFunction
  * rateLimiter.maybeExecute('123');
  * ```
  */
-export declare class RateLimiter<TFn extends AnyFunction> {
-    #private;
-    fn: TFn;
-    readonly store: Store<Readonly<RateLimiterState>>;
-    key: string | undefined;
-    options: RateLimiterOptions<TFn>;
-    constructor(fn: TFn, initialOptions: RateLimiterOptions<TFn>);
-    /**
-     * Updates the rate limiter options
-     */
-    setOptions: (newOptions: Partial<RateLimiterOptions<TFn>>) => void;
-    /**
-     * Attempts to execute the rate-limited function if within the configured limits.
-     * Will reject execution if the number of calls in the current window exceeds the limit.
-     *
-     * @example
-     * ```ts
-     * const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });
-     *
-     * // First 5 calls will return true
-     * rateLimiter.maybeExecute('arg1', 'arg2'); // true
-     *
-     * // Additional calls within the window will return false
-     * rateLimiter.maybeExecute('arg1', 'arg2'); // false
-     * ```
-     */
-    maybeExecute: (...args: Parameters<TFn>) => boolean;
-    /**
-     * Returns the number of remaining executions allowed in the current window
-     */
-    getRemainingInWindow: () => number;
-    /**
-     * Returns the number of milliseconds until the next execution will be possible
-     */
-    getMsUntilNextWindow: () => number;
-    /**
-     * Resets the rate limiter state
-     */
-    reset: () => void;
+declare class RateLimiter<TFn extends AnyFunction> {
+  #private;
+  fn: TFn;
+  readonly store: Store<Readonly<RateLimiterState>>;
+  key: string | undefined;
+  options: RateLimiterOptions<TFn>;
+  constructor(fn: TFn, initialOptions: RateLimiterOptions<TFn>);
+  /**
+   * Updates the rate limiter options
+   */
+  setOptions: (newOptions: Partial<RateLimiterOptions<TFn>>) => void;
+  /**
+   * Attempts to execute the rate-limited function if within the configured limits.
+   * Will reject execution if the number of calls in the current window exceeds the limit.
+   *
+   * @example
+   * ```ts
+   * const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });
+   *
+   * // First 5 calls will return true
+   * rateLimiter.maybeExecute('arg1', 'arg2'); // true
+   *
+   * // Additional calls within the window will return false
+   * rateLimiter.maybeExecute('arg1', 'arg2'); // false
+   * ```
+   */
+  maybeExecute: (...args: Parameters<TFn>) => boolean;
+  /**
+   * Returns the number of remaining executions allowed in the current window
+   */
+  getRemainingInWindow: () => number;
+  /**
+   * Returns the number of milliseconds until the next execution will be possible
+   */
+  getMsUntilNextWindow: () => number;
+  /**
+   * Resets the rate limiter state
+   */
+  reset: () => void;
 }
 /**
  * Creates a rate-limited function that will execute the provided function up to a maximum number of times within a time window.
@@ -207,4 +209,7 @@ export declare class RateLimiter<TFn extends AnyFunction> {
  * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
  * ```
  */
-export declare function rateLimit<TFn extends AnyFunction>(fn: TFn, initialOptions: RateLimiterOptions<TFn>): (...args: Parameters<TFn>) => boolean;
+declare function rateLimit<TFn extends AnyFunction>(fn: TFn, initialOptions: RateLimiterOptions<TFn>): (...args: Parameters<TFn>) => boolean;
+//#endregion
+export { RateLimiter, RateLimiterOptions, RateLimiterState, rateLimit, rateLimiterOptions };
+//# sourceMappingURL=rate-limiter.d.cts.map