@tanstack/solid-pacer 0.3.0 → 0.4.0

package/dist/cjs/async-rate-limiter/createAsyncRateLimiter.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"createAsyncRateLimiter.cjs","sources":["../../../src/async-rate-limiter/createAsyncRateLimiter.ts"],"sourcesContent":["import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { AsyncRateLimiterOptions } from '@tanstack/pacer/async-rate-limiter'\n\nexport interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction>\n  extends Omit<\n    AsyncRateLimiter<TFn>,\n    | 'getSuccessCount'\n    | 'getSettleCount'\n    | 'getErrorCount'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n    | 'getMsUntilNextWindow'\n  > {\n  successCount: Accessor<number>\n  settleCount: Accessor<number>\n  errorCount: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\n *\n * @example\n * ```tsx\n * // Basic API call rate limiting\n * const { maybeExecute } = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // With state management\n * const [data, setData] = createSignal(null);\n * const { maybeExecute } = createAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (info) => console.log(`Rate limit exceeded: ${info.nextValidTime - Date.now()}ms until next window`)\n *   }\n * );\n * ```\n */\nexport function createAsyncRateLimiter<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: AsyncRateLimiterOptions<TFn>,\n): SolidAsyncRateLimiter<TFn> {\n  const asyncRateLimiter = new AsyncRateLimiter<TFn>(fn, initialOptions)\n\n  const [successCount, setSuccessCount] = createSignal(\n    asyncRateLimiter.getSuccessCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    asyncRateLimiter.getRejectionCount(),\n  )\n  const [errorCount, setErrorCount] = createSignal(\n    asyncRateLimiter.getErrorCount(),\n  )\n  const [settleCount, setSettleCount] = createSignal(\n    asyncRateLimiter.getSettleCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    asyncRateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    asyncRateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>) {\n    asyncRateLimiter.setOptions({\n      ...newOptions,\n      onSettled: (rateLimiter) => {\n        setSuccessCount(rateLimiter.getSuccessCount())\n        setSettleCount(rateLimiter.getSettleCount())\n        setErrorCount(rateLimiter.getErrorCount())\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onSettled = newOptions.onSettled ?? initialOptions.onSettled\n        onSettled?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...bindInstanceMethods(asyncRateLimiter),\n    errorCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    rejectionCount,\n    setOptions,\n    settleCount,\n    successCount,\n  } as SolidAsyncRateLimiter<TFn>\n}\n"],"names":["asyncRateLimiter","AsyncRateLimiter","createSignal","bindInstanceMethods"],"mappings":";;;;;AA6DgB,SAAA,uBACd,IACA,gBAC4B;AAC5B,QAAMA,qBAAmB,IAAIC,kCAAsB,IAAI,cAAc;AAE/D,QAAA,CAAC,cAAc,eAAe,IAAIC,QAAA;AAAA,IACtCF,mBAAiB,gBAAgB;AAAA,EACnC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAIE,QAAA;AAAA,IAC1CF,mBAAiB,kBAAkB;AAAA,EACrC;AACM,QAAA,CAAC,YAAY,aAAa,IAAIE,QAAA;AAAA,IAClCF,mBAAiB,cAAc;AAAA,EACjC;AACM,QAAA,CAAC,aAAa,cAAc,IAAIE,QAAA;AAAA,IACpCF,mBAAiB,eAAe;AAAA,EAClC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAIE,QAAA;AAAA,IAChDF,mBAAiB,qBAAqB;AAAA,EACxC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAIE,QAAA;AAAA,IAChDF,mBAAiB,qBAAqB;AAAA,EACxC;AAEA,WAAS,WAAW,YAAmD;AACrEA,uBAAiB,WAAW;AAAA,MAC1B,GAAG;AAAA,MACH,WAAW,CAAC,gBAAgB;AACV,wBAAA,YAAY,iBAAiB;AAC9B,uBAAA,YAAY,gBAAgB;AAC7B,sBAAA,YAAY,eAAe;AACvB,0BAAA,YAAY,mBAAmB;AAC5B,6BAAA,YAAY,sBAAsB;AAClC,6BAAA,YAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAY;AAAA,MACd;AAAA,MACA,UAAU,CAAC,gBAAgB;AACP,0BAAA,YAAY,mBAAmB;AAC5B,6BAAA,YAAY,sBAAsB;AAClC,6BAAA,YAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAW;AAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAGG,MAAAA,oBAAoBH,kBAAgB;AAAA,IACvC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;;"}
+{"version":3,"file":"createAsyncRateLimiter.cjs","sources":["../../../src/async-rate-limiter/createAsyncRateLimiter.ts"],"sourcesContent":["import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { AsyncRateLimiterOptions } from '@tanstack/pacer/async-rate-limiter'\n\nexport interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction>\n  extends Omit<\n    AsyncRateLimiter<TFn>,\n    | 'getSuccessCount'\n    | 'getSettleCount'\n    | 'getErrorCount'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n    | 'getMsUntilNextWindow'\n  > {\n  successCount: Accessor<number>\n  settleCount: Accessor<number>\n  errorCount: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\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 * @example\n * ```tsx\n * // Basic API call rate limiting with return value\n * const { maybeExecute } = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // With state management and return value\n * const [data, setData] = createSignal(null);\n * const { maybeExecute } = createAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *     return result; // Return value can be used by the caller\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (info) => console.log(`Rate limit exceeded: ${info.nextValidTime - Date.now()}ms until next window`)\n *   }\n * );\n * ```\n */\nexport function createAsyncRateLimiter<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: AsyncRateLimiterOptions<TFn>,\n): SolidAsyncRateLimiter<TFn> {\n  const asyncRateLimiter = new AsyncRateLimiter<TFn>(fn, initialOptions)\n\n  const [successCount, setSuccessCount] = createSignal(\n    asyncRateLimiter.getSuccessCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    asyncRateLimiter.getRejectionCount(),\n  )\n  const [errorCount, setErrorCount] = createSignal(\n    asyncRateLimiter.getErrorCount(),\n  )\n  const [settleCount, setSettleCount] = createSignal(\n    asyncRateLimiter.getSettleCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    asyncRateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    asyncRateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>) {\n    asyncRateLimiter.setOptions({\n      ...newOptions,\n      onSettled: (rateLimiter) => {\n        setSuccessCount(rateLimiter.getSuccessCount())\n        setSettleCount(rateLimiter.getSettleCount())\n        setErrorCount(rateLimiter.getErrorCount())\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onSettled = newOptions.onSettled ?? initialOptions.onSettled\n        onSettled?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...bindInstanceMethods(asyncRateLimiter),\n    errorCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    rejectionCount,\n    setOptions,\n    settleCount,\n    successCount,\n  } as SolidAsyncRateLimiter<TFn>\n}\n"],"names":["asyncRateLimiter","AsyncRateLimiter","createSignal","bindInstanceMethods"],"mappings":";;;;;AAwEgB,SAAA,uBACd,IACA,gBAC4B;AAC5B,QAAMA,qBAAmB,IAAIC,kCAAsB,IAAI,cAAc;AAE/D,QAAA,CAAC,cAAc,eAAe,IAAIC,QAAA;AAAA,IACtCF,mBAAiB,gBAAgB;AAAA,EACnC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAIE,QAAA;AAAA,IAC1CF,mBAAiB,kBAAkB;AAAA,EACrC;AACM,QAAA,CAAC,YAAY,aAAa,IAAIE,QAAA;AAAA,IAClCF,mBAAiB,cAAc;AAAA,EACjC;AACM,QAAA,CAAC,aAAa,cAAc,IAAIE,QAAA;AAAA,IACpCF,mBAAiB,eAAe;AAAA,EAClC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAIE,QAAA;AAAA,IAChDF,mBAAiB,qBAAqB;AAAA,EACxC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAIE,QAAA;AAAA,IAChDF,mBAAiB,qBAAqB;AAAA,EACxC;AAEA,WAAS,WAAW,YAAmD;AACrEA,uBAAiB,WAAW;AAAA,MAC1B,GAAG;AAAA,MACH,WAAW,CAAC,gBAAgB;AACV,wBAAA,YAAY,iBAAiB;AAC9B,uBAAA,YAAY,gBAAgB;AAC7B,sBAAA,YAAY,eAAe;AACvB,0BAAA,YAAY,mBAAmB;AAC5B,6BAAA,YAAY,sBAAsB;AAClC,6BAAA,YAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAY;AAAA,MACd;AAAA,MACA,UAAU,CAAC,gBAAgB;AACP,0BAAA,YAAY,mBAAmB;AAC5B,6BAAA,YAAY,sBAAsB;AAClC,6BAAA,YAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAW;AAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAGG,MAAAA,oBAAoBH,kBAAgB;AAAA,IACvC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;;"}

package/dist/cjs/async-rate-limiter/createAsyncRateLimiter.d.cts

@@ -19,23 +19,34 @@ export interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction> extends Omi
  * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,
  * managing resource constraints, or controlling bursts of async operations.
  *
+ * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
+ * instead of setting the result on a state variable from within the rate-limited function.
+ *
+ * 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.
+ *
  * @example
  * ```tsx
- * // Basic API call rate limiting
+ * // Basic API call rate limiting with return value
  * const { maybeExecute } = createAsyncRateLimiter(
  *   async (id: string) => {
  *     const data = await api.fetchData(id);
- *     return data;
+ *     return data; // Return value is preserved
  *   },
  *   { limit: 5, window: 1000 } // 5 calls per second
  * );
  *
- * // With state management
+ * // With state management and return value
  * const [data, setData] = createSignal(null);
  * const { maybeExecute } = createAsyncRateLimiter(
  *   async (query) => {
  *     const result = await searchAPI(query);
  *     setData(result);
+ *     return result; // Return value can be used by the caller
  *   },
  *   {
  *     limit: 10,

package/dist/cjs/rate-limiter/createRateLimitedSignal.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"createRateLimitedSignal.cjs","sources":["../../../src/rate-limiter/createRateLimitedSignal.ts"],"sourcesContent":["import { createSignal } from 'solid-js'\nimport { createRateLimiter } from './createRateLimiter'\nimport type { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A Solid hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.\n * This hook combines Solid's createSignal with rate limiting functionality to provide controlled state updates.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.\n *\n * For smoother update patterns, consider:\n * - createThrottledSignal: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedSignal: When you want to collapse rapid updates into a single update (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.\n *\n * The hook returns a tuple containing:\n * - The rate-limited state value accessor\n * - A rate-limited setter function that respects the configured limits\n * - The rateLimiter instance for additional control\n *\n * For more direct control over rate limiting without state management,\n * consider using the lower-level createRateLimiter hook instead.\n *\n * @example\n * ```tsx\n * // Basic rate limiting - update state at most 5 times per minute\n * const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {\n *   limit: 5,\n *   window: 60000\n * });\n *\n * // With rejection callback\n * const [value, setValue] = createRateLimitedSignal(0, {\n *   limit: 3,\n *   window: 5000,\n *   onReject: (rateLimiter) => {\n *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // Access rateLimiter state via signals\n * const handleSubmit = () => {\n *   const remaining = rateLimiter.remainingInWindow();\n *   if (remaining > 0) {\n *     setValue(newValue);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n * ```\n */\nexport function createRateLimitedSignal<TValue>(\n  value: TValue,\n  initialOptions: RateLimiterOptions<Setter<TValue>>,\n): [Accessor<TValue>, Setter<TValue>, SolidRateLimiter<Setter<TValue>>] {\n  const [rateLimitedValue, setRateLimitedValue] = createSignal<TValue>(value)\n\n  const rateLimiter = createRateLimiter(setRateLimitedValue, initialOptions)\n\n  return [\n    rateLimitedValue,\n    rateLimiter.maybeExecute.bind(rateLimiter) as Setter<TValue>,\n    rateLimiter,\n  ]\n}\n"],"names":["createSignal","createRateLimiter"],"mappings":";;;;AAwDgB,SAAA,wBACd,OACA,gBACsE;AACtE,QAAM,CAAC,kBAAkB,mBAAmB,IAAIA,QAAAA,aAAqB,KAAK;AAEpE,QAAA,cAAcC,kBAAAA,kBAAkB,qBAAqB,cAAc;AAElE,SAAA;AAAA,IACL;AAAA,IACA,YAAY,aAAa,KAAK,WAAW;AAAA,IACzC;AAAA,EACF;AACF;;"}
+{"version":3,"file":"createRateLimitedSignal.cjs","sources":["../../../src/rate-limiter/createRateLimitedSignal.ts"],"sourcesContent":["import { createSignal } from 'solid-js'\nimport { createRateLimiter } from './createRateLimiter'\nimport type { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A Solid hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.\n * This hook combines Solid's createSignal with rate limiting functionality to provide controlled state updates.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All updates within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more\n *   consistent rate of updates over time.\n *\n * For smoother update patterns, consider:\n * - createThrottledSignal: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedSignal: When you want to collapse rapid updates into a single update (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.\n *\n * The hook returns a tuple containing:\n * - The rate-limited state value accessor\n * - A rate-limited setter function that respects the configured limits\n * - The rateLimiter instance for additional control\n *\n * For more direct control over rate limiting without state management,\n * consider using the lower-level createRateLimiter hook instead.\n *\n * @example\n * ```tsx\n * // Basic rate limiting - update state at most 5 times per minute with a sliding window\n * const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // With rejection callback and fixed window\n * const [value, setValue] = createRateLimitedSignal(0, {\n *   limit: 3,\n *   window: 5000,\n *   windowType: 'fixed',\n *   onReject: (rateLimiter) => {\n *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // Access rateLimiter state via signals\n * const handleSubmit = () => {\n *   const remaining = rateLimiter.remainingInWindow();\n *   if (remaining > 0) {\n *     setValue(newValue);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n * ```\n */\nexport function createRateLimitedSignal<TValue>(\n  value: TValue,\n  initialOptions: RateLimiterOptions<Setter<TValue>>,\n): [Accessor<TValue>, Setter<TValue>, SolidRateLimiter<Setter<TValue>>] {\n  const [rateLimitedValue, setRateLimitedValue] = createSignal<TValue>(value)\n\n  const rateLimiter = createRateLimiter(setRateLimitedValue, initialOptions)\n\n  return [\n    rateLimitedValue,\n    rateLimiter.maybeExecute.bind(rateLimiter) as Setter<TValue>,\n    rateLimiter,\n  ]\n}\n"],"names":["createSignal","createRateLimiter"],"mappings":";;;;AAgEgB,SAAA,wBACd,OACA,gBACsE;AACtE,QAAM,CAAC,kBAAkB,mBAAmB,IAAIA,QAAAA,aAAqB,KAAK;AAEpE,QAAA,cAAcC,kBAAAA,kBAAkB,qBAAqB,cAAc;AAElE,SAAA;AAAA,IACL;AAAA,IACA,YAAY,aAAa,KAAK,WAAW;AAAA,IACzC;AAAA,EACF;AACF;;"}

package/dist/cjs/rate-limiter/createRateLimitedSignal.d.cts

@@ -9,6 +9,12 @@ import { RateLimiterOptions } from '@tanstack/pacer/rate-limiter';
  * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out
  * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.
  *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All updates within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more
+ *   consistent rate of updates over time.
+ *
  * For smoother update patterns, consider:
  * - createThrottledSignal: When you want consistent spacing between updates (e.g. UI changes)
  * - createDebouncedSignal: When you want to collapse rapid updates into a single update (e.g. search input)
@@ -25,16 +31,18 @@ import { RateLimiterOptions } from '@tanstack/pacer/rate-limiter';
  *
  * @example
  * ```tsx
- * // Basic rate limiting - update state at most 5 times per minute
+ * // Basic rate limiting - update state at most 5 times per minute with a sliding window
  * const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {
  *   limit: 5,
- *   window: 60000
+ *   window: 60000,
+ *   windowType: 'sliding'
  * });
  *
- * // With rejection callback
+ * // With rejection callback and fixed window
  * const [value, setValue] = createRateLimitedSignal(0, {
  *   limit: 3,
  *   window: 5000,
+ *   windowType: 'fixed',
  *   onReject: (rateLimiter) => {
  *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  *   }

package/dist/cjs/rate-limiter/createRateLimitedValue.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"createRateLimitedValue.cjs","sources":["../../../src/rate-limiter/createRateLimitedValue.ts"],"sourcesContent":["import { createEffect } from 'solid-js'\nimport { createRateLimitedSignal } from './createRateLimitedSignal'\nimport type { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A high-level Solid hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window.\n * This hook uses Solid's createSignal internally to manage the rate-limited state.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.\n *\n * For smoother update patterns, consider:\n * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedValue: When you want to collapse rapid updates into a single update (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.\n *\n * The hook returns a tuple containing:\n * - An accessor function that provides the rate-limited value\n * - The rate limiter instance with control methods\n *\n * For more direct control over rate limiting behavior without Solid state management,\n * consider using the lower-level createRateLimiter hook instead.\n *\n * @example\n * ```tsx\n * // Basic rate limiting - update at most 5 times per minute\n * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(rawValue, {\n *   limit: 5,\n *   window: 60000\n * });\n *\n * // Use the rate-limited value\n * console.log(rateLimitedValue()); // Access the current rate-limited value\n *\n * // Control the rate limiter\n * rateLimiter.reset(); // Reset the rate limit window\n * ```\n */\nexport function createRateLimitedValue<TValue>(\n  value: Accessor<TValue>,\n  initialOptions: RateLimiterOptions<Setter<TValue>>,\n): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>>] {\n  const [rateLimitedValue, setRateLimitedValue, rateLimiter] =\n    createRateLimitedSignal(value(), initialOptions)\n\n  createEffect(() => {\n    setRateLimitedValue(value() as any)\n  })\n\n  return [rateLimitedValue, rateLimiter]\n}\n"],"names":["createRateLimitedSignal","createEffect"],"mappings":";;;;AA0CgB,SAAA,uBACd,OACA,gBACsD;AAChD,QAAA,CAAC,kBAAkB,qBAAqB,WAAW,IACvDA,gDAAwB,SAAS,cAAc;AAEjDC,UAAAA,aAAa,MAAM;AACjB,wBAAoB,OAAc;AAAA,EAAA,CACnC;AAEM,SAAA,CAAC,kBAAkB,WAAW;AACvC;;"}
+{"version":3,"file":"createRateLimitedValue.cjs","sources":["../../../src/rate-limiter/createRateLimitedValue.ts"],"sourcesContent":["import { createEffect } from 'solid-js'\nimport { createRateLimitedSignal } from './createRateLimitedSignal'\nimport type { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A high-level Solid hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window.\n * This hook uses Solid's createSignal internally to manage the rate-limited state.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All updates within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more\n *   consistent rate of updates over time.\n *\n * For smoother update patterns, consider:\n * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedValue: When you want to collapse rapid updates into a single update (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.\n *\n * The hook returns a tuple containing:\n * - An accessor function that provides the rate-limited value\n * - The rate limiter instance with control methods\n *\n * For more direct control over rate limiting behavior without Solid state management,\n * consider using the lower-level createRateLimiter hook instead.\n *\n * @example\n * ```tsx\n * // Basic rate limiting - update at most 5 times per minute with a sliding window\n * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(rawValue, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // Use the rate-limited value\n * console.log(rateLimitedValue()); // Access the current rate-limited value\n *\n * // Control the rate limiter\n * rateLimiter.reset(); // Reset the rate limit window\n * ```\n */\nexport function createRateLimitedValue<TValue>(\n  value: Accessor<TValue>,\n  initialOptions: RateLimiterOptions<Setter<TValue>>,\n): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>>] {\n  const [rateLimitedValue, setRateLimitedValue, rateLimiter] =\n    createRateLimitedSignal(value(), initialOptions)\n\n  createEffect(() => {\n    setRateLimitedValue(value() as any)\n  })\n\n  return [rateLimitedValue, rateLimiter]\n}\n"],"names":["createRateLimitedSignal","createEffect"],"mappings":";;;;AAiDgB,SAAA,uBACd,OACA,gBACsD;AAChD,QAAA,CAAC,kBAAkB,qBAAqB,WAAW,IACvDA,gDAAwB,SAAS,cAAc;AAEjDC,UAAAA,aAAa,MAAM;AACjB,wBAAoB,OAAc;AAAA,EAAA,CACnC;AAEM,SAAA,CAAC,kBAAkB,WAAW;AACvC;;"}

package/dist/cjs/rate-limiter/createRateLimitedValue.d.cts

@@ -9,6 +9,12 @@ import { RateLimiterOptions } from '@tanstack/pacer/rate-limiter';
  * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out
  * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.
  *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All updates within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more
+ *   consistent rate of updates over time.
+ *
  * For smoother update patterns, consider:
  * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)
  * - createDebouncedValue: When you want to collapse rapid updates into a single update (e.g. search input)
@@ -24,10 +30,11 @@ import { RateLimiterOptions } from '@tanstack/pacer/rate-limiter';
  *
  * @example
  * ```tsx
- * // Basic rate limiting - update at most 5 times per minute
+ * // Basic rate limiting - update at most 5 times per minute with a sliding window
  * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(rawValue, {
  *   limit: 5,
- *   window: 60000
+ *   window: 60000,
+ *   windowType: 'sliding'
  * });
  *
  * // Use the rate-limited value

package/dist/cjs/rate-limiter/createRateLimiter.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"createRateLimiter.cjs","sources":["../../../src/rate-limiter/createRateLimiter.ts"],"sourcesContent":["import { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\nexport interface SolidRateLimiter<TFn extends AnyFunction>\n  extends Omit<\n    RateLimiter<TFn>,\n    | 'getExecutionCount'\n    | 'getMsUntilNextWindow'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n  > {\n  executionCount: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting is a simple \"hard limit\" approach that allows executions until a maximum count is reached within\n * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,\n * it does not attempt to space out or collapse executions intelligently.\n *\n * For smoother execution patterns:\n * - Use throttling when you want consistent spacing between executions (e.g. UI updates)\n * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)\n * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)\n *\n * @example\n * ```tsx\n * // Basic rate limiting - max 5 calls per minute\n * const rateLimiter = createRateLimiter(apiCall, {\n *   limit: 5,\n *   window: 60000,\n * });\n *\n * // Monitor rate limit status\n * const handleClick = () => {\n *   if (rateLimiter.remainingInWindow() > 0) {\n *     rateLimiter.maybeExecute(data);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n *\n * // Access rate limiter state via signals\n * console.log('Executions:', rateLimiter.executionCount());\n * console.log('Rejections:', rateLimiter.rejectionCount());\n * console.log('Remaining:', rateLimiter.remainingInWindow());\n * console.log('Next window in:', rateLimiter.msUntilNextWindow());\n * ```\n */\nexport function createRateLimiter<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn>,\n): SolidRateLimiter<TFn> {\n  const rateLimiter = bindInstanceMethods(\n    new RateLimiter<TFn>(fn, initialOptions),\n  )\n\n  const [executionCount, setExecutionCount] = createSignal(\n    rateLimiter.getExecutionCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    rateLimiter.getRejectionCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    rateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    rateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<RateLimiterOptions<TFn>>) {\n    rateLimiter.setOptions({\n      ...newOptions,\n      onExecute: (rateLimiter) => {\n        setExecutionCount(rateLimiter.getExecutionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onExecute = newOptions.onExecute ?? initialOptions.onExecute\n        onExecute?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...rateLimiter,\n    executionCount,\n    rejectionCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    setOptions,\n  } as SolidRateLimiter<TFn>\n}\n"],"names":["rateLimiter","bindInstanceMethods","RateLimiter","createSignal"],"mappings":";;;;;AA4DgB,SAAA,kBACd,IACA,gBACuB;AACvB,QAAMA,gBAAcC,MAAA;AAAA,IAClB,IAAIC,YAAAA,YAAiB,IAAI,cAAc;AAAA,EACzC;AAEM,QAAA,CAAC,gBAAgB,iBAAiB,IAAIC,QAAA;AAAA,IAC1CH,cAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAIG,QAAA;AAAA,IAC1CH,cAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAIG,QAAA;AAAA,IAChDH,cAAY,qBAAqB;AAAA,EACnC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAIG,QAAA;AAAA,IAChDH,cAAY,qBAAqB;AAAA,EACnC;AAEA,WAAS,WAAW,YAA8C;AAChEA,kBAAY,WAAW;AAAA,MACrB,GAAG;AAAA,MACH,WAAW,CAACA,iBAAgB;AACRA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAYA;AAAAA,MACd;AAAA,MACA,UAAU,CAACA,iBAAgB;AACPA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAWA;AAAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAGA;AAAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;;"}
+{"version":3,"file":"createRateLimiter.cjs","sources":["../../../src/rate-limiter/createRateLimiter.ts"],"sourcesContent":["import { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\nexport interface SolidRateLimiter<TFn extends AnyFunction>\n  extends Omit<\n    RateLimiter<TFn>,\n    | 'getExecutionCount'\n    | 'getMsUntilNextWindow'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n  > {\n  executionCount: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting is a simple \"hard limit\" approach that allows executions until a maximum count is reached within\n * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,\n * it does not attempt to space out or collapse executions intelligently.\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:\n * - Use throttling when you want consistent spacing between executions (e.g. UI updates)\n * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)\n * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)\n *\n * @example\n * ```tsx\n * // Basic rate limiting - max 5 calls per minute with a sliding window\n * const rateLimiter = createRateLimiter(apiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // Monitor rate limit status\n * const handleClick = () => {\n *   if (rateLimiter.remainingInWindow() > 0) {\n *     rateLimiter.maybeExecute(data);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n *\n * // Access rate limiter state via signals\n * console.log('Executions:', rateLimiter.executionCount());\n * console.log('Rejections:', rateLimiter.rejectionCount());\n * console.log('Remaining:', rateLimiter.remainingInWindow());\n * console.log('Next window in:', rateLimiter.msUntilNextWindow());\n * ```\n */\nexport function createRateLimiter<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn>,\n): SolidRateLimiter<TFn> {\n  const rateLimiter = bindInstanceMethods(\n    new RateLimiter<TFn>(fn, initialOptions),\n  )\n\n  const [executionCount, setExecutionCount] = createSignal(\n    rateLimiter.getExecutionCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    rateLimiter.getRejectionCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    rateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    rateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<RateLimiterOptions<TFn>>) {\n    rateLimiter.setOptions({\n      ...newOptions,\n      onExecute: (rateLimiter) => {\n        setExecutionCount(rateLimiter.getExecutionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onExecute = newOptions.onExecute ?? initialOptions.onExecute\n        onExecute?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...rateLimiter,\n    executionCount,\n    rejectionCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    setOptions,\n  } as SolidRateLimiter<TFn>\n}\n"],"names":["rateLimiter","bindInstanceMethods","RateLimiter","createSignal"],"mappings":";;;;;AAmEgB,SAAA,kBACd,IACA,gBACuB;AACvB,QAAMA,gBAAcC,MAAA;AAAA,IAClB,IAAIC,YAAAA,YAAiB,IAAI,cAAc;AAAA,EACzC;AAEM,QAAA,CAAC,gBAAgB,iBAAiB,IAAIC,QAAA;AAAA,IAC1CH,cAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAIG,QAAA;AAAA,IAC1CH,cAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAIG,QAAA;AAAA,IAChDH,cAAY,qBAAqB;AAAA,EACnC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAIG,QAAA;AAAA,IAChDH,cAAY,qBAAqB;AAAA,EACnC;AAEA,WAAS,WAAW,YAA8C;AAChEA,kBAAY,WAAW;AAAA,MACrB,GAAG;AAAA,MACH,WAAW,CAACA,iBAAgB;AACRA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAYA;AAAAA,MACd;AAAA,MACA,UAAU,CAACA,iBAAgB;AACPA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAWA;AAAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAGA;AAAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;;"}

package/dist/cjs/rate-limiter/createRateLimiter.d.cts

@@ -17,6 +17,12 @@ export interface SolidRateLimiter<TFn extends AnyFunction> extends Omit<RateLimi
  * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,
  * it does not attempt to space out or collapse executions intelligently.
  *
+ * 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:
  * - Use throttling when you want consistent spacing between executions (e.g. UI updates)
  * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)
@@ -24,10 +30,11 @@ export interface SolidRateLimiter<TFn extends AnyFunction> extends Omit<RateLimi
  *
  * @example
  * ```tsx
- * // Basic rate limiting - max 5 calls per minute
+ * // Basic rate limiting - max 5 calls per minute with a sliding window
  * const rateLimiter = createRateLimiter(apiCall, {
  *   limit: 5,
  *   window: 60000,
+ *   windowType: 'sliding'
  * });
  *
  * // Monitor rate limit status

package/dist/esm/async-rate-limiter/createAsyncRateLimiter.d.ts

@@ -19,23 +19,34 @@ export interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction> extends Omi
  * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,
  * managing resource constraints, or controlling bursts of async operations.
  *
+ * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
+ * instead of setting the result on a state variable from within the rate-limited function.
+ *
+ * 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.
+ *
  * @example
  * ```tsx
- * // Basic API call rate limiting
+ * // Basic API call rate limiting with return value
  * const { maybeExecute } = createAsyncRateLimiter(
  *   async (id: string) => {
  *     const data = await api.fetchData(id);
- *     return data;
+ *     return data; // Return value is preserved
  *   },
  *   { limit: 5, window: 1000 } // 5 calls per second
  * );
  *
- * // With state management
+ * // With state management and return value
  * const [data, setData] = createSignal(null);
  * const { maybeExecute } = createAsyncRateLimiter(
  *   async (query) => {
  *     const result = await searchAPI(query);
  *     setData(result);
+ *     return result; // Return value can be used by the caller
  *   },
  *   {
  *     limit: 10,

package/dist/esm/async-rate-limiter/createAsyncRateLimiter.js.map

@@ -1 +1 @@
-{"version":3,"file":"createAsyncRateLimiter.js","sources":["../../../src/async-rate-limiter/createAsyncRateLimiter.ts"],"sourcesContent":["import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { AsyncRateLimiterOptions } from '@tanstack/pacer/async-rate-limiter'\n\nexport interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction>\n  extends Omit<\n    AsyncRateLimiter<TFn>,\n    | 'getSuccessCount'\n    | 'getSettleCount'\n    | 'getErrorCount'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n    | 'getMsUntilNextWindow'\n  > {\n  successCount: Accessor<number>\n  settleCount: Accessor<number>\n  errorCount: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\n *\n * @example\n * ```tsx\n * // Basic API call rate limiting\n * const { maybeExecute } = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // With state management\n * const [data, setData] = createSignal(null);\n * const { maybeExecute } = createAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (info) => console.log(`Rate limit exceeded: ${info.nextValidTime - Date.now()}ms until next window`)\n *   }\n * );\n * ```\n */\nexport function createAsyncRateLimiter<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: AsyncRateLimiterOptions<TFn>,\n): SolidAsyncRateLimiter<TFn> {\n  const asyncRateLimiter = new AsyncRateLimiter<TFn>(fn, initialOptions)\n\n  const [successCount, setSuccessCount] = createSignal(\n    asyncRateLimiter.getSuccessCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    asyncRateLimiter.getRejectionCount(),\n  )\n  const [errorCount, setErrorCount] = createSignal(\n    asyncRateLimiter.getErrorCount(),\n  )\n  const [settleCount, setSettleCount] = createSignal(\n    asyncRateLimiter.getSettleCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    asyncRateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    asyncRateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>) {\n    asyncRateLimiter.setOptions({\n      ...newOptions,\n      onSettled: (rateLimiter) => {\n        setSuccessCount(rateLimiter.getSuccessCount())\n        setSettleCount(rateLimiter.getSettleCount())\n        setErrorCount(rateLimiter.getErrorCount())\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onSettled = newOptions.onSettled ?? initialOptions.onSettled\n        onSettled?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...bindInstanceMethods(asyncRateLimiter),\n    errorCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    rejectionCount,\n    setOptions,\n    settleCount,\n    successCount,\n  } as SolidAsyncRateLimiter<TFn>\n}\n"],"names":[],"mappings":";;;AA6DgB,SAAA,uBACd,IACA,gBAC4B;AAC5B,QAAM,mBAAmB,IAAI,iBAAsB,IAAI,cAAc;AAE/D,QAAA,CAAC,cAAc,eAAe,IAAI;AAAA,IACtC,iBAAiB,gBAAgB;AAAA,EACnC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,iBAAiB,kBAAkB;AAAA,EACrC;AACM,QAAA,CAAC,YAAY,aAAa,IAAI;AAAA,IAClC,iBAAiB,cAAc;AAAA,EACjC;AACM,QAAA,CAAC,aAAa,cAAc,IAAI;AAAA,IACpC,iBAAiB,eAAe;AAAA,EAClC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,iBAAiB,qBAAqB;AAAA,EACxC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,iBAAiB,qBAAqB;AAAA,EACxC;AAEA,WAAS,WAAW,YAAmD;AACrE,qBAAiB,WAAW;AAAA,MAC1B,GAAG;AAAA,MACH,WAAW,CAAC,gBAAgB;AACV,wBAAA,YAAY,iBAAiB;AAC9B,uBAAA,YAAY,gBAAgB;AAC7B,sBAAA,YAAY,eAAe;AACvB,0BAAA,YAAY,mBAAmB;AAC5B,6BAAA,YAAY,sBAAsB;AAClC,6BAAA,YAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAY;AAAA,MACd;AAAA,MACA,UAAU,CAAC,gBAAgB;AACP,0BAAA,YAAY,mBAAmB;AAC5B,6BAAA,YAAY,sBAAsB;AAClC,6BAAA,YAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAW;AAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG,oBAAoB,gBAAgB;AAAA,IACvC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}
+{"version":3,"file":"createAsyncRateLimiter.js","sources":["../../../src/async-rate-limiter/createAsyncRateLimiter.ts"],"sourcesContent":["import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { AsyncRateLimiterOptions } from '@tanstack/pacer/async-rate-limiter'\n\nexport interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction>\n  extends Omit<\n    AsyncRateLimiter<TFn>,\n    | 'getSuccessCount'\n    | 'getSettleCount'\n    | 'getErrorCount'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n    | 'getMsUntilNextWindow'\n  > {\n  successCount: Accessor<number>\n  settleCount: Accessor<number>\n  errorCount: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\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 * @example\n * ```tsx\n * // Basic API call rate limiting with return value\n * const { maybeExecute } = createAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // With state management and return value\n * const [data, setData] = createSignal(null);\n * const { maybeExecute } = createAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *     return result; // Return value can be used by the caller\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (info) => console.log(`Rate limit exceeded: ${info.nextValidTime - Date.now()}ms until next window`)\n *   }\n * );\n * ```\n */\nexport function createAsyncRateLimiter<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: AsyncRateLimiterOptions<TFn>,\n): SolidAsyncRateLimiter<TFn> {\n  const asyncRateLimiter = new AsyncRateLimiter<TFn>(fn, initialOptions)\n\n  const [successCount, setSuccessCount] = createSignal(\n    asyncRateLimiter.getSuccessCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    asyncRateLimiter.getRejectionCount(),\n  )\n  const [errorCount, setErrorCount] = createSignal(\n    asyncRateLimiter.getErrorCount(),\n  )\n  const [settleCount, setSettleCount] = createSignal(\n    asyncRateLimiter.getSettleCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    asyncRateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    asyncRateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<AsyncRateLimiterOptions<TFn>>) {\n    asyncRateLimiter.setOptions({\n      ...newOptions,\n      onSettled: (rateLimiter) => {\n        setSuccessCount(rateLimiter.getSuccessCount())\n        setSettleCount(rateLimiter.getSettleCount())\n        setErrorCount(rateLimiter.getErrorCount())\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onSettled = newOptions.onSettled ?? initialOptions.onSettled\n        onSettled?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...bindInstanceMethods(asyncRateLimiter),\n    errorCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    rejectionCount,\n    setOptions,\n    settleCount,\n    successCount,\n  } as SolidAsyncRateLimiter<TFn>\n}\n"],"names":[],"mappings":";;;AAwEgB,SAAA,uBACd,IACA,gBAC4B;AAC5B,QAAM,mBAAmB,IAAI,iBAAsB,IAAI,cAAc;AAE/D,QAAA,CAAC,cAAc,eAAe,IAAI;AAAA,IACtC,iBAAiB,gBAAgB;AAAA,EACnC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,iBAAiB,kBAAkB;AAAA,EACrC;AACM,QAAA,CAAC,YAAY,aAAa,IAAI;AAAA,IAClC,iBAAiB,cAAc;AAAA,EACjC;AACM,QAAA,CAAC,aAAa,cAAc,IAAI;AAAA,IACpC,iBAAiB,eAAe;AAAA,EAClC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,iBAAiB,qBAAqB;AAAA,EACxC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,iBAAiB,qBAAqB;AAAA,EACxC;AAEA,WAAS,WAAW,YAAmD;AACrE,qBAAiB,WAAW;AAAA,MAC1B,GAAG;AAAA,MACH,WAAW,CAAC,gBAAgB;AACV,wBAAA,YAAY,iBAAiB;AAC9B,uBAAA,YAAY,gBAAgB;AAC7B,sBAAA,YAAY,eAAe;AACvB,0BAAA,YAAY,mBAAmB;AAC5B,6BAAA,YAAY,sBAAsB;AAClC,6BAAA,YAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAY;AAAA,MACd;AAAA,MACA,UAAU,CAAC,gBAAgB;AACP,0BAAA,YAAY,mBAAmB;AAC5B,6BAAA,YAAY,sBAAsB;AAClC,6BAAA,YAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAW;AAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG,oBAAoB,gBAAgB;AAAA,IACvC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}

package/dist/esm/rate-limiter/createRateLimitedSignal.d.ts

@@ -9,6 +9,12 @@ import { RateLimiterOptions } from '@tanstack/pacer/rate-limiter';
  * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out
  * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.
  *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All updates within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more
+ *   consistent rate of updates over time.
+ *
  * For smoother update patterns, consider:
  * - createThrottledSignal: When you want consistent spacing between updates (e.g. UI changes)
  * - createDebouncedSignal: When you want to collapse rapid updates into a single update (e.g. search input)
@@ -25,16 +31,18 @@ import { RateLimiterOptions } from '@tanstack/pacer/rate-limiter';
  *
  * @example
  * ```tsx
- * // Basic rate limiting - update state at most 5 times per minute
+ * // Basic rate limiting - update state at most 5 times per minute with a sliding window
  * const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {
  *   limit: 5,
- *   window: 60000
+ *   window: 60000,
+ *   windowType: 'sliding'
  * });
  *
- * // With rejection callback
+ * // With rejection callback and fixed window
  * const [value, setValue] = createRateLimitedSignal(0, {
  *   limit: 3,
  *   window: 5000,
+ *   windowType: 'fixed',
  *   onReject: (rateLimiter) => {
  *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  *   }

package/dist/esm/rate-limiter/createRateLimitedSignal.js.map

@@ -1 +1 @@
-{"version":3,"file":"createRateLimitedSignal.js","sources":["../../../src/rate-limiter/createRateLimitedSignal.ts"],"sourcesContent":["import { createSignal } from 'solid-js'\nimport { createRateLimiter } from './createRateLimiter'\nimport type { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A Solid hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.\n * This hook combines Solid's createSignal with rate limiting functionality to provide controlled state updates.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.\n *\n * For smoother update patterns, consider:\n * - createThrottledSignal: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedSignal: When you want to collapse rapid updates into a single update (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.\n *\n * The hook returns a tuple containing:\n * - The rate-limited state value accessor\n * - A rate-limited setter function that respects the configured limits\n * - The rateLimiter instance for additional control\n *\n * For more direct control over rate limiting without state management,\n * consider using the lower-level createRateLimiter hook instead.\n *\n * @example\n * ```tsx\n * // Basic rate limiting - update state at most 5 times per minute\n * const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {\n *   limit: 5,\n *   window: 60000\n * });\n *\n * // With rejection callback\n * const [value, setValue] = createRateLimitedSignal(0, {\n *   limit: 3,\n *   window: 5000,\n *   onReject: (rateLimiter) => {\n *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // Access rateLimiter state via signals\n * const handleSubmit = () => {\n *   const remaining = rateLimiter.remainingInWindow();\n *   if (remaining > 0) {\n *     setValue(newValue);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n * ```\n */\nexport function createRateLimitedSignal<TValue>(\n  value: TValue,\n  initialOptions: RateLimiterOptions<Setter<TValue>>,\n): [Accessor<TValue>, Setter<TValue>, SolidRateLimiter<Setter<TValue>>] {\n  const [rateLimitedValue, setRateLimitedValue] = createSignal<TValue>(value)\n\n  const rateLimiter = createRateLimiter(setRateLimitedValue, initialOptions)\n\n  return [\n    rateLimitedValue,\n    rateLimiter.maybeExecute.bind(rateLimiter) as Setter<TValue>,\n    rateLimiter,\n  ]\n}\n"],"names":[],"mappings":";;AAwDgB,SAAA,wBACd,OACA,gBACsE;AACtE,QAAM,CAAC,kBAAkB,mBAAmB,IAAI,aAAqB,KAAK;AAEpE,QAAA,cAAc,kBAAkB,qBAAqB,cAAc;AAElE,SAAA;AAAA,IACL;AAAA,IACA,YAAY,aAAa,KAAK,WAAW;AAAA,IACzC;AAAA,EACF;AACF;"}
+{"version":3,"file":"createRateLimitedSignal.js","sources":["../../../src/rate-limiter/createRateLimitedSignal.ts"],"sourcesContent":["import { createSignal } from 'solid-js'\nimport { createRateLimiter } from './createRateLimiter'\nimport type { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A Solid hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.\n * This hook combines Solid's createSignal with rate limiting functionality to provide controlled state updates.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All updates within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more\n *   consistent rate of updates over time.\n *\n * For smoother update patterns, consider:\n * - createThrottledSignal: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedSignal: When you want to collapse rapid updates into a single update (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.\n *\n * The hook returns a tuple containing:\n * - The rate-limited state value accessor\n * - A rate-limited setter function that respects the configured limits\n * - The rateLimiter instance for additional control\n *\n * For more direct control over rate limiting without state management,\n * consider using the lower-level createRateLimiter hook instead.\n *\n * @example\n * ```tsx\n * // Basic rate limiting - update state at most 5 times per minute with a sliding window\n * const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // With rejection callback and fixed window\n * const [value, setValue] = createRateLimitedSignal(0, {\n *   limit: 3,\n *   window: 5000,\n *   windowType: 'fixed',\n *   onReject: (rateLimiter) => {\n *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // Access rateLimiter state via signals\n * const handleSubmit = () => {\n *   const remaining = rateLimiter.remainingInWindow();\n *   if (remaining > 0) {\n *     setValue(newValue);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n * ```\n */\nexport function createRateLimitedSignal<TValue>(\n  value: TValue,\n  initialOptions: RateLimiterOptions<Setter<TValue>>,\n): [Accessor<TValue>, Setter<TValue>, SolidRateLimiter<Setter<TValue>>] {\n  const [rateLimitedValue, setRateLimitedValue] = createSignal<TValue>(value)\n\n  const rateLimiter = createRateLimiter(setRateLimitedValue, initialOptions)\n\n  return [\n    rateLimitedValue,\n    rateLimiter.maybeExecute.bind(rateLimiter) as Setter<TValue>,\n    rateLimiter,\n  ]\n}\n"],"names":[],"mappings":";;AAgEgB,SAAA,wBACd,OACA,gBACsE;AACtE,QAAM,CAAC,kBAAkB,mBAAmB,IAAI,aAAqB,KAAK;AAEpE,QAAA,cAAc,kBAAkB,qBAAqB,cAAc;AAElE,SAAA;AAAA,IACL;AAAA,IACA,YAAY,aAAa,KAAK,WAAW;AAAA,IACzC;AAAA,EACF;AACF;"}

package/dist/esm/rate-limiter/createRateLimitedValue.d.ts

@@ -9,6 +9,12 @@ import { RateLimiterOptions } from '@tanstack/pacer/rate-limiter';
  * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out
  * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.
  *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All updates within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more
+ *   consistent rate of updates over time.
+ *
  * For smoother update patterns, consider:
  * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)
  * - createDebouncedValue: When you want to collapse rapid updates into a single update (e.g. search input)
@@ -24,10 +30,11 @@ import { RateLimiterOptions } from '@tanstack/pacer/rate-limiter';
  *
  * @example
  * ```tsx
- * // Basic rate limiting - update at most 5 times per minute
+ * // Basic rate limiting - update at most 5 times per minute with a sliding window
  * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(rawValue, {
  *   limit: 5,
- *   window: 60000
+ *   window: 60000,
+ *   windowType: 'sliding'
  * });
  *
  * // Use the rate-limited value

package/dist/esm/rate-limiter/createRateLimitedValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"createRateLimitedValue.js","sources":["../../../src/rate-limiter/createRateLimitedValue.ts"],"sourcesContent":["import { createEffect } from 'solid-js'\nimport { createRateLimitedSignal } from './createRateLimitedSignal'\nimport type { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A high-level Solid hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window.\n * This hook uses Solid's createSignal internally to manage the rate-limited state.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.\n *\n * For smoother update patterns, consider:\n * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedValue: When you want to collapse rapid updates into a single update (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.\n *\n * The hook returns a tuple containing:\n * - An accessor function that provides the rate-limited value\n * - The rate limiter instance with control methods\n *\n * For more direct control over rate limiting behavior without Solid state management,\n * consider using the lower-level createRateLimiter hook instead.\n *\n * @example\n * ```tsx\n * // Basic rate limiting - update at most 5 times per minute\n * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(rawValue, {\n *   limit: 5,\n *   window: 60000\n * });\n *\n * // Use the rate-limited value\n * console.log(rateLimitedValue()); // Access the current rate-limited value\n *\n * // Control the rate limiter\n * rateLimiter.reset(); // Reset the rate limit window\n * ```\n */\nexport function createRateLimitedValue<TValue>(\n  value: Accessor<TValue>,\n  initialOptions: RateLimiterOptions<Setter<TValue>>,\n): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>>] {\n  const [rateLimitedValue, setRateLimitedValue, rateLimiter] =\n    createRateLimitedSignal(value(), initialOptions)\n\n  createEffect(() => {\n    setRateLimitedValue(value() as any)\n  })\n\n  return [rateLimitedValue, rateLimiter]\n}\n"],"names":[],"mappings":";;AA0CgB,SAAA,uBACd,OACA,gBACsD;AAChD,QAAA,CAAC,kBAAkB,qBAAqB,WAAW,IACvD,wBAAwB,SAAS,cAAc;AAEjD,eAAa,MAAM;AACjB,wBAAoB,OAAc;AAAA,EAAA,CACnC;AAEM,SAAA,CAAC,kBAAkB,WAAW;AACvC;"}
+{"version":3,"file":"createRateLimitedValue.js","sources":["../../../src/rate-limiter/createRateLimitedValue.ts"],"sourcesContent":["import { createEffect } from 'solid-js'\nimport { createRateLimitedSignal } from './createRateLimitedSignal'\nimport type { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A high-level Solid hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window.\n * This hook uses Solid's createSignal internally to manage the rate-limited state.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All updates within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more\n *   consistent rate of updates over time.\n *\n * For smoother update patterns, consider:\n * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedValue: When you want to collapse rapid updates into a single update (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.\n *\n * The hook returns a tuple containing:\n * - An accessor function that provides the rate-limited value\n * - The rate limiter instance with control methods\n *\n * For more direct control over rate limiting behavior without Solid state management,\n * consider using the lower-level createRateLimiter hook instead.\n *\n * @example\n * ```tsx\n * // Basic rate limiting - update at most 5 times per minute with a sliding window\n * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(rawValue, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // Use the rate-limited value\n * console.log(rateLimitedValue()); // Access the current rate-limited value\n *\n * // Control the rate limiter\n * rateLimiter.reset(); // Reset the rate limit window\n * ```\n */\nexport function createRateLimitedValue<TValue>(\n  value: Accessor<TValue>,\n  initialOptions: RateLimiterOptions<Setter<TValue>>,\n): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>>] {\n  const [rateLimitedValue, setRateLimitedValue, rateLimiter] =\n    createRateLimitedSignal(value(), initialOptions)\n\n  createEffect(() => {\n    setRateLimitedValue(value() as any)\n  })\n\n  return [rateLimitedValue, rateLimiter]\n}\n"],"names":[],"mappings":";;AAiDgB,SAAA,uBACd,OACA,gBACsD;AAChD,QAAA,CAAC,kBAAkB,qBAAqB,WAAW,IACvD,wBAAwB,SAAS,cAAc;AAEjD,eAAa,MAAM;AACjB,wBAAoB,OAAc;AAAA,EAAA,CACnC;AAEM,SAAA,CAAC,kBAAkB,WAAW;AACvC;"}

package/dist/esm/rate-limiter/createRateLimiter.d.ts

@@ -17,6 +17,12 @@ export interface SolidRateLimiter<TFn extends AnyFunction> extends Omit<RateLimi
  * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,
  * it does not attempt to space out or collapse executions intelligently.
  *
+ * 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:
  * - Use throttling when you want consistent spacing between executions (e.g. UI updates)
  * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)
@@ -24,10 +30,11 @@ export interface SolidRateLimiter<TFn extends AnyFunction> extends Omit<RateLimi
  *
  * @example
  * ```tsx
- * // Basic rate limiting - max 5 calls per minute
+ * // Basic rate limiting - max 5 calls per minute with a sliding window
  * const rateLimiter = createRateLimiter(apiCall, {
  *   limit: 5,
  *   window: 60000,
+ *   windowType: 'sliding'
  * });
  *
  * // Monitor rate limit status

package/dist/esm/rate-limiter/createRateLimiter.js.map

@@ -1 +1 @@
-{"version":3,"file":"createRateLimiter.js","sources":["../../../src/rate-limiter/createRateLimiter.ts"],"sourcesContent":["import { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\nexport interface SolidRateLimiter<TFn extends AnyFunction>\n  extends Omit<\n    RateLimiter<TFn>,\n    | 'getExecutionCount'\n    | 'getMsUntilNextWindow'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n  > {\n  executionCount: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting is a simple \"hard limit\" approach that allows executions until a maximum count is reached within\n * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,\n * it does not attempt to space out or collapse executions intelligently.\n *\n * For smoother execution patterns:\n * - Use throttling when you want consistent spacing between executions (e.g. UI updates)\n * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)\n * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)\n *\n * @example\n * ```tsx\n * // Basic rate limiting - max 5 calls per minute\n * const rateLimiter = createRateLimiter(apiCall, {\n *   limit: 5,\n *   window: 60000,\n * });\n *\n * // Monitor rate limit status\n * const handleClick = () => {\n *   if (rateLimiter.remainingInWindow() > 0) {\n *     rateLimiter.maybeExecute(data);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n *\n * // Access rate limiter state via signals\n * console.log('Executions:', rateLimiter.executionCount());\n * console.log('Rejections:', rateLimiter.rejectionCount());\n * console.log('Remaining:', rateLimiter.remainingInWindow());\n * console.log('Next window in:', rateLimiter.msUntilNextWindow());\n * ```\n */\nexport function createRateLimiter<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn>,\n): SolidRateLimiter<TFn> {\n  const rateLimiter = bindInstanceMethods(\n    new RateLimiter<TFn>(fn, initialOptions),\n  )\n\n  const [executionCount, setExecutionCount] = createSignal(\n    rateLimiter.getExecutionCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    rateLimiter.getRejectionCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    rateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    rateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<RateLimiterOptions<TFn>>) {\n    rateLimiter.setOptions({\n      ...newOptions,\n      onExecute: (rateLimiter) => {\n        setExecutionCount(rateLimiter.getExecutionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onExecute = newOptions.onExecute ?? initialOptions.onExecute\n        onExecute?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...rateLimiter,\n    executionCount,\n    rejectionCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    setOptions,\n  } as SolidRateLimiter<TFn>\n}\n"],"names":["rateLimiter"],"mappings":";;;AA4DgB,SAAA,kBACd,IACA,gBACuB;AACvB,QAAM,cAAc;AAAA,IAClB,IAAI,YAAiB,IAAI,cAAc;AAAA,EACzC;AAEM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,YAAY,qBAAqB;AAAA,EACnC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,YAAY,qBAAqB;AAAA,EACnC;AAEA,WAAS,WAAW,YAA8C;AAChE,gBAAY,WAAW;AAAA,MACrB,GAAG;AAAA,MACH,WAAW,CAACA,iBAAgB;AACRA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAYA;AAAAA,MACd;AAAA,MACA,UAAU,CAACA,iBAAgB;AACPA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAWA;AAAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}
+{"version":3,"file":"createRateLimiter.js","sources":["../../../src/rate-limiter/createRateLimiter.ts"],"sourcesContent":["import { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { createSignal } from 'solid-js'\nimport { bindInstanceMethods } from '@tanstack/pacer/utils'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\nexport interface SolidRateLimiter<TFn extends AnyFunction>\n  extends Omit<\n    RateLimiter<TFn>,\n    | 'getExecutionCount'\n    | 'getMsUntilNextWindow'\n    | 'getRejectionCount'\n    | 'getRemainingInWindow'\n  > {\n  executionCount: Accessor<number>\n  msUntilNextWindow: Accessor<number>\n  rejectionCount: Accessor<number>\n  remainingInWindow: Accessor<number>\n}\n\n/**\n * A low-level Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (createSignal, etc).\n *\n * Rate limiting is a simple \"hard limit\" approach that allows executions until a maximum count is reached within\n * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,\n * it does not attempt to space out or collapse executions intelligently.\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:\n * - Use throttling when you want consistent spacing between executions (e.g. UI updates)\n * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)\n * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)\n *\n * @example\n * ```tsx\n * // Basic rate limiting - max 5 calls per minute with a sliding window\n * const rateLimiter = createRateLimiter(apiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // Monitor rate limit status\n * const handleClick = () => {\n *   if (rateLimiter.remainingInWindow() > 0) {\n *     rateLimiter.maybeExecute(data);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n *\n * // Access rate limiter state via signals\n * console.log('Executions:', rateLimiter.executionCount());\n * console.log('Rejections:', rateLimiter.rejectionCount());\n * console.log('Remaining:', rateLimiter.remainingInWindow());\n * console.log('Next window in:', rateLimiter.msUntilNextWindow());\n * ```\n */\nexport function createRateLimiter<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn>,\n): SolidRateLimiter<TFn> {\n  const rateLimiter = bindInstanceMethods(\n    new RateLimiter<TFn>(fn, initialOptions),\n  )\n\n  const [executionCount, setExecutionCount] = createSignal(\n    rateLimiter.getExecutionCount(),\n  )\n  const [rejectionCount, setRejectionCount] = createSignal(\n    rateLimiter.getRejectionCount(),\n  )\n  const [remainingInWindow, setRemainingInWindow] = createSignal(\n    rateLimiter.getRemainingInWindow(),\n  )\n  const [msUntilNextWindow, setMsUntilNextWindow] = createSignal(\n    rateLimiter.getMsUntilNextWindow(),\n  )\n\n  function setOptions(newOptions: Partial<RateLimiterOptions<TFn>>) {\n    rateLimiter.setOptions({\n      ...newOptions,\n      onExecute: (rateLimiter) => {\n        setExecutionCount(rateLimiter.getExecutionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onExecute = newOptions.onExecute ?? initialOptions.onExecute\n        onExecute?.(rateLimiter)\n      },\n      onReject: (rateLimiter) => {\n        setRejectionCount(rateLimiter.getRejectionCount())\n        setRemainingInWindow(rateLimiter.getRemainingInWindow())\n        setMsUntilNextWindow(rateLimiter.getMsUntilNextWindow())\n\n        const onReject = newOptions.onReject ?? initialOptions.onReject\n        onReject?.(rateLimiter)\n      },\n    })\n  }\n\n  setOptions(initialOptions)\n\n  return {\n    ...rateLimiter,\n    executionCount,\n    rejectionCount,\n    remainingInWindow,\n    msUntilNextWindow,\n    setOptions,\n  } as SolidRateLimiter<TFn>\n}\n"],"names":["rateLimiter"],"mappings":";;;AAmEgB,SAAA,kBACd,IACA,gBACuB;AACvB,QAAM,cAAc;AAAA,IAClB,IAAI,YAAiB,IAAI,cAAc;AAAA,EACzC;AAEM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,gBAAgB,iBAAiB,IAAI;AAAA,IAC1C,YAAY,kBAAkB;AAAA,EAChC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,YAAY,qBAAqB;AAAA,EACnC;AACM,QAAA,CAAC,mBAAmB,oBAAoB,IAAI;AAAA,IAChD,YAAY,qBAAqB;AAAA,EACnC;AAEA,WAAS,WAAW,YAA8C;AAChE,gBAAY,WAAW;AAAA,MACrB,GAAG;AAAA,MACH,WAAW,CAACA,iBAAgB;AACRA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,YAAY,WAAW,aAAa,eAAe;AACzD,+CAAYA;AAAAA,MACd;AAAA,MACA,UAAU,CAACA,iBAAgB;AACPA,0BAAAA,aAAY,mBAAmB;AAC5BA,6BAAAA,aAAY,sBAAsB;AAClCA,6BAAAA,aAAY,sBAAsB;AAEjD,cAAA,WAAW,WAAW,YAAY,eAAe;AACvD,6CAAWA;AAAAA,MAAW;AAAA,IACxB,CACD;AAAA,EAAA;AAGH,aAAW,cAAc;AAElB,SAAA;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-pacer",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Utilities for debouncing and throttling functions in Solid.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -142,10 +142,10 @@
     "src"
   ],
   "dependencies": {
-    "@tanstack/pacer": "0.3.0"
+    "@tanstack/pacer": "0.4.0"
   },
   "devDependencies": {
-    "solid-js": "^1.9.5",
+    "solid-js": "^1.9.6",
     "vite-plugin-solid": "^2.11.6"
   },
   "peerDependencies": {

package/src/async-rate-limiter/createAsyncRateLimiter.ts

@@ -33,23 +33,34 @@ export interface SolidAsyncRateLimiter<TFn extends AnyAsyncFunction>
  * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,
  * managing resource constraints, or controlling bursts of async operations.
  *
+ * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,
+ * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
+ * instead of setting the result on a state variable from within the rate-limited function.
+ *
+ * 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.
+ *
  * @example
  * ```tsx
- * // Basic API call rate limiting
+ * // Basic API call rate limiting with return value
  * const { maybeExecute } = createAsyncRateLimiter(
  *   async (id: string) => {
  *     const data = await api.fetchData(id);
- *     return data;
+ *     return data; // Return value is preserved
  *   },
  *   { limit: 5, window: 1000 } // 5 calls per second
  * );
  *
- * // With state management
+ * // With state management and return value
  * const [data, setData] = createSignal(null);
  * const { maybeExecute } = createAsyncRateLimiter(
  *   async (query) => {
  *     const result = await searchAPI(query);
  *     setData(result);
+ *     return result; // Return value can be used by the caller
  *   },
  *   {
  *     limit: 10,

package/src/rate-limiter/createRateLimitedSignal.ts

@@ -12,6 +12,12 @@ import type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'
  * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out
  * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.
  *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All updates within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more
+ *   consistent rate of updates over time.
+ *
  * For smoother update patterns, consider:
  * - createThrottledSignal: When you want consistent spacing between updates (e.g. UI changes)
  * - createDebouncedSignal: When you want to collapse rapid updates into a single update (e.g. search input)
@@ -28,16 +34,18 @@ import type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'
  *
  * @example
  * ```tsx
- * // Basic rate limiting - update state at most 5 times per minute
+ * // Basic rate limiting - update state at most 5 times per minute with a sliding window
  * const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {
  *   limit: 5,
- *   window: 60000
+ *   window: 60000,
+ *   windowType: 'sliding'
  * });
  *
- * // With rejection callback
+ * // With rejection callback and fixed window
  * const [value, setValue] = createRateLimitedSignal(0, {
  *   limit: 3,
  *   window: 5000,
+ *   windowType: 'fixed',
  *   onReject: (rateLimiter) => {
  *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  *   }

package/src/rate-limiter/createRateLimitedValue.ts

@@ -12,6 +12,12 @@ import type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'
  * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out
  * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.
  *
+ * The rate limiter supports two types of windows:
+ * - 'fixed': A strict window that resets after the window period. All updates within the window count
+ *   towards the limit, and the window resets completely after the period.
+ * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more
+ *   consistent rate of updates over time.
+ *
  * For smoother update patterns, consider:
  * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)
  * - createDebouncedValue: When you want to collapse rapid updates into a single update (e.g. search input)
@@ -27,10 +33,11 @@ import type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'
  *
  * @example
  * ```tsx
- * // Basic rate limiting - update at most 5 times per minute
+ * // Basic rate limiting - update at most 5 times per minute with a sliding window
  * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(rawValue, {
  *   limit: 5,
- *   window: 60000
+ *   window: 60000,
+ *   windowType: 'sliding'
  * });
  *
  * // Use the rate-limited value

package/src/rate-limiter/createRateLimiter.ts

@@ -29,6 +29,12 @@ export interface SolidRateLimiter<TFn extends AnyFunction>
  * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,
  * it does not attempt to space out or collapse executions intelligently.
  *
+ * 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:
  * - Use throttling when you want consistent spacing between executions (e.g. UI updates)
  * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)
@@ -36,10 +42,11 @@ export interface SolidRateLimiter<TFn extends AnyFunction>
  *
  * @example
  * ```tsx
- * // Basic rate limiting - max 5 calls per minute
+ * // Basic rate limiting - max 5 calls per minute with a sliding window
  * const rateLimiter = createRateLimiter(apiCall, {
  *   limit: 5,
  *   window: 60000,
+ *   windowType: 'sliding'
  * });
  *
  * // Monitor rate limit status