@tanstack/angular-pacer 0.23.1 → 0.25.0

package/dist/rate-limiter/injectRateLimiter.d.cts

@@ -1,103 +0,0 @@
-import { Signal } from "@angular/core";
-import { Store } from "@tanstack/angular-store";
-import { AnyFunction } from "@tanstack/pacer/types";
-import { RateLimiter, RateLimiterOptions, RateLimiterState } from "@tanstack/pacer/rate-limiter";
-
-//#region src/rate-limiter/injectRateLimiter.d.ts
-interface AngularRateLimiterOptions<TFn extends AnyFunction, TSelected = {}> extends RateLimiterOptions<TFn> {
-  /**
-   * Optional callback invoked when the component is destroyed. Receives the rate limiter instance.
-   */
-  onUnmount?: (rateLimiter: AngularRateLimiter<TFn, TSelected>) => void;
-}
-interface AngularRateLimiter<TFn extends AnyFunction, TSelected = {}> extends Omit<RateLimiter<TFn>, 'store'> {
-  /**
-   * Reactive state signal that will be updated when the rate limiter state changes
-   *
-   * Use this instead of `rateLimiter.store.state`
-   */
-  readonly state: Signal<Readonly<TSelected>>;
-  /**
-   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.store.state` if you want to read reactive state.
-   * The state on the store object is not reactive in Angular signals.
-   */
-  readonly store: Store<Readonly<RateLimiterState>>;
-}
-/**
- * An Angular function that creates and manages a RateLimiter instance.
- *
- * This is a lower-level function that provides direct access to the RateLimiter's functionality.
- * This allows you to integrate it with any state management solution you prefer.
- *
- * Rate limiting is a simple "hard limit" approach that allows executions until a maximum count is reached within
- * 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)
- * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)
- *
- * ## State Management and Selector
- *
- * The function uses TanStack Store for state management and wraps it with Angular signals.
- * The `selector` parameter allows you to specify which state changes will trigger signal updates,
- * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
- *
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
- * tracking by providing a selector function. This prevents unnecessary updates and gives you
- * full control over when your component tracks state changes.
- *
- * Available state properties:
- * - `executionCount`: Number of function executions that have been completed
- * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
- * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
- *
- * ## Cleanup on Destroy
- *
- * Use the `onUnmount` option to run a callback when the component is destroyed.
- *
- * @example
- * ```ts
- * // Default behavior - no reactive state subscriptions
- * const rateLimiter = injectRateLimiter(apiCall, {
- *   limit: 5,
- *   window: 60000,
- *   windowType: 'sliding',
- * });
- *
- * // Opt-in to track execution count changes
- * const rateLimiter = injectRateLimiter(
- *   apiCall,
- *   {
- *     limit: 5,
- *     window: 60000,
- *     windowType: 'sliding',
- *   },
- *   (state) => ({ executionCount: state.executionCount })
- * );
- *
- * // Monitor rate limit status
- * const handleClick = () => {
- *   const remaining = rateLimiter.getRemainingInWindow();
- *   if (remaining > 0) {
- *     rateLimiter.maybeExecute(data);
- *   } else {
- *     showRateLimitWarning();
- *   }
- * };
- *
- * // Access the selected state (will be empty object {} unless selector provided)
- * const { executionCount, rejectionCount } = rateLimiter.state();
- * ```
- */
-declare function injectRateLimiter<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: AngularRateLimiterOptions<TFn, TSelected>, selector?: (state: RateLimiterState) => TSelected): AngularRateLimiter<TFn, TSelected>;
-//#endregion
-export { AngularRateLimiter, AngularRateLimiterOptions, injectRateLimiter };
-//# sourceMappingURL=injectRateLimiter.d.cts.map

package/dist/rate-limiter/injectRateLimiter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"injectRateLimiter.js","names":[],"sources":["../../src/rate-limiter/injectRateLimiter.ts"],"sourcesContent":["import { DestroyRef, inject } from '@angular/core'\nimport { injectSelector } from '@tanstack/angular-store'\nimport { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/angular-store'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n  RateLimiterOptions,\n  RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\n\nexport interface AngularRateLimiterOptions<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends RateLimiterOptions<TFn> {\n  /**\n   * Optional callback invoked when the component is destroyed. Receives the rate limiter instance.\n   */\n  onUnmount?: (rateLimiter: AngularRateLimiter<TFn, TSelected>) => void\n}\n\nexport interface AngularRateLimiter<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<RateLimiter<TFn>, 'store'> {\n  /**\n   * Reactive state signal that will be updated when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Signal<Readonly<TSelected>>\n  /**\n   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive in Angular signals.\n   */\n  readonly store: Store<Readonly<RateLimiterState>>\n}\n\n/**\n * An Angular function that creates and manages a RateLimiter instance.\n *\n * This is a lower-level function that provides direct access to the RateLimiter's functionality.\n * This allows you to integrate it with any state management solution you prefer.\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 * ## State Management and Selector\n *\n * The function uses TanStack Store for state management and wraps it with Angular signals.\n * The `selector` parameter allows you to specify which state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * Available state properties:\n * - `executionCount`: Number of function executions that have been completed\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n *\n * ## Cleanup on Destroy\n *\n * Use the `onUnmount` option to run a callback when the component is destroyed.\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const rateLimiter = injectRateLimiter(apiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\n * });\n *\n * // Opt-in to track execution count changes\n * const rateLimiter = injectRateLimiter(\n *   apiCall,\n *   {\n *     limit: 5,\n *     window: 60000,\n *     windowType: 'sliding',\n *   },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Monitor rate limit status\n * const handleClick = () => {\n *   const remaining = rateLimiter.getRemainingInWindow();\n *   if (remaining > 0) {\n *     rateLimiter.maybeExecute(data);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { executionCount, rejectionCount } = rateLimiter.state();\n * ```\n */\nexport function injectRateLimiter<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: AngularRateLimiterOptions<TFn, TSelected>,\n  selector: (state: RateLimiterState) => TSelected = () => ({}) as TSelected,\n): AngularRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...injectPacerOptions().rateLimiter,\n    ...options,\n  } as AngularRateLimiterOptions<TFn, TSelected>\n\n  const rateLimiter = new RateLimiter<TFn>(fn, mergedOptions)\n  const state = injectSelector(rateLimiter.store, selector)\n\n  const result = {\n    ...rateLimiter,\n    state,\n  } as AngularRateLimiter<TFn, TSelected>\n\n  const destroyRef = inject(DestroyRef, { optional: true })\n  destroyRef?.onDestroy(() => {\n    if (mergedOptions.onUnmount) {\n      mergedOptions.onUnmount(result)\n    }\n  })\n\n  return result\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiHA,SAAgB,kBACd,IACA,SACA,kBAA0D,EAAE,GACxB;CACpC,MAAM,gBAAgB;EACpB,GAAG,oBAAoB,CAAC;EACxB,GAAG;EACJ;CAED,MAAM,cAAc,IAAI,YAAiB,IAAI,cAAc;CAC3D,MAAM,QAAQ,eAAe,YAAY,OAAO,SAAS;CAEzD,MAAM,SAAS;EACb,GAAG;EACH;EACD;CAGD,AADmB,OAAO,YAAY,EAAE,UAAU,MAAM,CAC9C,EAAE,gBAAgB;EAC1B,IAAI,cAAc,WAChB,cAAc,UAAU,OAAO;GAEjC;CAEF,OAAO"}

package/dist/throttler/index.cjs

@@ -1,17 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_injectThrottler = require('./injectThrottler.cjs');
-const require_injectThrottledCallback = require('./injectThrottledCallback.cjs');
-const require_injectThrottledSignal = require('./injectThrottledSignal.cjs');
-const require_injectThrottledValue = require('./injectThrottledValue.cjs');
-
-exports.injectThrottledCallback = require_injectThrottledCallback.injectThrottledCallback;
-exports.injectThrottledSignal = require_injectThrottledSignal.injectThrottledSignal;
-exports.injectThrottledValue = require_injectThrottledValue.injectThrottledValue;
-exports.injectThrottler = require_injectThrottler.injectThrottler;
-var _tanstack_pacer_throttler = require("@tanstack/pacer/throttler");
-Object.keys(_tanstack_pacer_throttler).forEach(function (k) {
-  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
-    enumerable: true,
-    get: function () { return _tanstack_pacer_throttler[k]; }
-  });
-});

package/dist/throttler/index.d.cts

@@ -1,6 +0,0 @@
-import { injectThrottledCallback } from "./injectThrottledCallback.cjs";
-import { AngularThrottler, AngularThrottlerOptions, injectThrottler } from "./injectThrottler.cjs";
-import { ThrottledSignal, injectThrottledSignal } from "./injectThrottledSignal.cjs";
-import { injectThrottledValue } from "./injectThrottledValue.cjs";
-export * from "@tanstack/pacer/throttler";
-export { AngularThrottler, AngularThrottlerOptions, ThrottledSignal, injectThrottledCallback, injectThrottledSignal, injectThrottledValue, injectThrottler };

package/dist/throttler/injectThrottledCallback.cjs

@@ -1,45 +0,0 @@
-const require_injectThrottler = require('./injectThrottler.cjs');
-
-//#region src/throttler/injectThrottledCallback.ts
-/**
-* An Angular function that creates a throttled version of a callback function.
-* This function is essentially a wrapper around `injectThrottler` that provides
-* a simplified API for basic throttling needs.
-*
-* The throttled function will execute at most once within the specified wait time.
-* If called multiple times within the wait period, only the first call (if leading is enabled)
-* or the last call (if trailing is enabled) will execute.
-*
-* This function provides a simpler API compared to `injectThrottler`, making it ideal for basic
-* throttling needs. However, it does not expose the underlying Throttler instance.
-*
-* For advanced usage requiring features like:
-* - Manual cancellation
-* - Access to execution counts
-* - State tracking
-*
-* Consider using the `injectThrottler` function instead.
-*
-* @example
-* ```ts
-* // Throttle a scroll handler
-* const handleScroll = injectThrottledCallback((scrollY: number) => {
-*   updateScrollPosition(scrollY);
-* }, {
-*   wait: 100 // Execute at most once per 100ms
-* });
-*
-* // Use in an event listener
-* window.addEventListener('scroll', () => {
-*   handleScroll(window.scrollY);
-* });
-* ```
-*/
-function injectThrottledCallback(fn, options) {
-	const throttler = require_injectThrottler.injectThrottler(fn, options);
-	return (...args) => throttler.maybeExecute(...args);
-}
-
-//#endregion
-exports.injectThrottledCallback = injectThrottledCallback;
-//# sourceMappingURL=injectThrottledCallback.cjs.map

package/dist/throttler/injectThrottledCallback.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"injectThrottledCallback.cjs","names":["injectThrottler"],"sources":["../../src/throttler/injectThrottledCallback.ts"],"sourcesContent":["import { injectThrottler } from './injectThrottler'\nimport type { ThrottlerOptions } from '@tanstack/pacer/throttler'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\n/**\n * An Angular function that creates a throttled version of a callback function.\n * This function is essentially a wrapper around `injectThrottler` that provides\n * a simplified API for basic throttling needs.\n *\n * The throttled function will execute at most once within the specified wait time.\n * If called multiple times within the wait period, only the first call (if leading is enabled)\n * or the last call (if trailing is enabled) will execute.\n *\n * This function provides a simpler API compared to `injectThrottler`, making it ideal for basic\n * throttling needs. However, it does not expose the underlying Throttler instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - State tracking\n *\n * Consider using the `injectThrottler` function instead.\n *\n * @example\n * ```ts\n * // Throttle a scroll handler\n * const handleScroll = injectThrottledCallback((scrollY: number) => {\n *   updateScrollPosition(scrollY);\n * }, {\n *   wait: 100 // Execute at most once per 100ms\n * });\n *\n * // Use in an event listener\n * window.addEventListener('scroll', () => {\n *   handleScroll(window.scrollY);\n * });\n * ```\n */\nexport function injectThrottledCallback<TFn extends AnyFunction>(\n  fn: TFn,\n  options: ThrottlerOptions<TFn>,\n): (...args: Parameters<TFn>) => void {\n  const throttler = injectThrottler(fn, options)\n  return (...args: Parameters<TFn>) => throttler.maybeExecute(...args)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCA,SAAgB,wBACd,IACA,SACoC;CACpC,MAAM,YAAYA,wCAAgB,IAAI,QAAQ;CAC9C,QAAQ,GAAG,SAA0B,UAAU,aAAa,GAAG,KAAK"}

package/dist/throttler/injectThrottledCallback.d.cts

@@ -1,42 +0,0 @@
-import { AnyFunction } from "@tanstack/pacer/types";
-import { ThrottlerOptions } from "@tanstack/pacer/throttler";
-
-//#region src/throttler/injectThrottledCallback.d.ts
-/**
- * An Angular function that creates a throttled version of a callback function.
- * This function is essentially a wrapper around `injectThrottler` that provides
- * a simplified API for basic throttling needs.
- *
- * The throttled function will execute at most once within the specified wait time.
- * If called multiple times within the wait period, only the first call (if leading is enabled)
- * or the last call (if trailing is enabled) will execute.
- *
- * This function provides a simpler API compared to `injectThrottler`, making it ideal for basic
- * throttling needs. However, it does not expose the underlying Throttler instance.
- *
- * For advanced usage requiring features like:
- * - Manual cancellation
- * - Access to execution counts
- * - State tracking
- *
- * Consider using the `injectThrottler` function instead.
- *
- * @example
- * ```ts
- * // Throttle a scroll handler
- * const handleScroll = injectThrottledCallback((scrollY: number) => {
- *   updateScrollPosition(scrollY);
- * }, {
- *   wait: 100 // Execute at most once per 100ms
- * });
- *
- * // Use in an event listener
- * window.addEventListener('scroll', () => {
- *   handleScroll(window.scrollY);
- * });
- * ```
- */
-declare function injectThrottledCallback<TFn extends AnyFunction>(fn: TFn, options: ThrottlerOptions<TFn>): (...args: Parameters<TFn>) => void;
-//#endregion
-export { injectThrottledCallback };
-//# sourceMappingURL=injectThrottledCallback.d.cts.map

package/dist/throttler/injectThrottledCallback.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"injectThrottledCallback.js","names":[],"sources":["../../src/throttler/injectThrottledCallback.ts"],"sourcesContent":["import { injectThrottler } from './injectThrottler'\nimport type { ThrottlerOptions } from '@tanstack/pacer/throttler'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\n/**\n * An Angular function that creates a throttled version of a callback function.\n * This function is essentially a wrapper around `injectThrottler` that provides\n * a simplified API for basic throttling needs.\n *\n * The throttled function will execute at most once within the specified wait time.\n * If called multiple times within the wait period, only the first call (if leading is enabled)\n * or the last call (if trailing is enabled) will execute.\n *\n * This function provides a simpler API compared to `injectThrottler`, making it ideal for basic\n * throttling needs. However, it does not expose the underlying Throttler instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - State tracking\n *\n * Consider using the `injectThrottler` function instead.\n *\n * @example\n * ```ts\n * // Throttle a scroll handler\n * const handleScroll = injectThrottledCallback((scrollY: number) => {\n *   updateScrollPosition(scrollY);\n * }, {\n *   wait: 100 // Execute at most once per 100ms\n * });\n *\n * // Use in an event listener\n * window.addEventListener('scroll', () => {\n *   handleScroll(window.scrollY);\n * });\n * ```\n */\nexport function injectThrottledCallback<TFn extends AnyFunction>(\n  fn: TFn,\n  options: ThrottlerOptions<TFn>,\n): (...args: Parameters<TFn>) => void {\n  const throttler = injectThrottler(fn, options)\n  return (...args: Parameters<TFn>) => throttler.maybeExecute(...args)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCA,SAAgB,wBACd,IACA,SACoC;CACpC,MAAM,YAAY,gBAAgB,IAAI,QAAQ;CAC9C,QAAQ,GAAG,SAA0B,UAAU,aAAa,GAAG,KAAK"}

package/dist/throttler/injectThrottledSignal.cjs

@@ -1,69 +0,0 @@
-const require_injectThrottler = require('./injectThrottler.cjs');
-let _angular_core = require("@angular/core");
-
-//#region src/throttler/injectThrottledSignal.ts
-/**
-* An Angular function that creates a throttled state signal, combining Angular's signal with throttling functionality.
-* This function provides both the current throttled value and methods to update it.
-*
-* The state value is updated at most once within the specified wait time.
-* This is useful for handling frequent state updates that should be rate-limited, like scroll positions
-* or mouse movements.
-*
-* The function returns a callable object:
-* - `throttled()`: Get the current throttled value
-* - `throttled.set(...)`: Set or update the throttled value (throttled via maybeExecute)
-* - `throttled.throttler`: The throttler instance with additional control methods and state signals
-*
-* ## State Management and Selector
-*
-* The function uses TanStack Store for reactive state management via the underlying throttler instance.
-* The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,
-* optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
-*
-* **By default, there will be no reactive state subscriptions** and you must opt-in to state
-* tracking by providing a selector function. This prevents unnecessary updates and gives you
-* full control over when your component tracks state changes.
-*
-* Available throttler state properties:
-* - `canLeadingExecute`: Whether the throttler can execute on the leading edge
-* - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
-* - `executionCount`: Number of function executions that have been completed
-* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
-* - `lastArgs`: The arguments from the most recent call to maybeExecute
-* - `lastExecutionTime`: Timestamp of the last execution
-* - `nextExecutionTime`: Timestamp of the next allowed execution
-* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
-*
-* @example
-* ```ts
-* const throttledScrollY = injectThrottledSignal(0, { wait: 100 })
-*
-* // Get value
-* console.log(throttledScrollY())
-*
-* // Set/update value (throttled)
-* throttledScrollY.set(window.scrollY)
-*
-* // Access throttler
-* console.log(throttledScrollY.throttler.state().isPending)
-* ```
-*/
-function injectThrottledSignal(value, initialOptions, selector) {
-	const throttledValue = (0, _angular_core.signal)(value);
-	const throttler = require_injectThrottler.injectThrottler((newValue) => {
-		if (typeof newValue === "function") throttledValue.update(newValue);
-		else throttledValue.set(newValue);
-	}, initialOptions, selector);
-	const set = (newValue) => {
-		throttler.maybeExecute(newValue);
-	};
-	return Object.assign(() => throttledValue(), {
-		set,
-		throttler
-	});
-}
-
-//#endregion
-exports.injectThrottledSignal = injectThrottledSignal;
-//# sourceMappingURL=injectThrottledSignal.cjs.map

package/dist/throttler/injectThrottledSignal.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"injectThrottledSignal.cjs","names":["injectThrottler"],"sources":["../../src/throttler/injectThrottledSignal.ts"],"sourcesContent":["import { signal } from '@angular/core'\nimport { injectThrottler } from './injectThrottler'\nimport type { AngularThrottler } from './injectThrottler'\nimport type {\n  ThrottlerOptions,\n  ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\nexport interface ThrottledSignal<TValue, TSelected = {}> {\n  (): TValue\n  set: Setter<TValue>\n  throttler: AngularThrottler<Setter<TValue>, TSelected>\n}\n\n/**\n * An Angular function that creates a throttled state signal, combining Angular's signal with throttling functionality.\n * This function provides both the current throttled value and methods to update it.\n *\n * The state value is updated at most once within the specified wait time.\n * This is useful for handling frequent state updates that should be rate-limited, like scroll positions\n * or mouse movements.\n *\n * The function returns a callable object:\n * - `throttled()`: Get the current throttled value\n * - `throttled.set(...)`: Set or update the throttled value (throttled via maybeExecute)\n * - `throttled.throttler`: The throttler instance with additional control methods and state signals\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```ts\n * const throttledScrollY = injectThrottledSignal(0, { wait: 100 })\n *\n * // Get value\n * console.log(throttledScrollY())\n *\n * // Set/update value (throttled)\n * throttledScrollY.set(window.scrollY)\n *\n * // Access throttler\n * console.log(throttledScrollY.throttler.state().isPending)\n * ```\n */\nexport function injectThrottledSignal<TValue, TSelected = {}>(\n  value: TValue,\n  initialOptions: ThrottlerOptions<Setter<TValue>>,\n  selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected> {\n  const throttledValue = signal<TValue>(value)\n\n  const throttler = injectThrottler(\n    (newValue: TValue | ((prev: TValue) => TValue)) => {\n      if (typeof newValue === 'function') {\n        throttledValue.update(newValue as (prev: TValue) => TValue)\n      } else {\n        throttledValue.set(newValue)\n      }\n    },\n    initialOptions,\n    selector,\n  )\n\n  const set: Setter<TValue> = (\n    newValue: TValue | ((prev: TValue) => TValue),\n  ) => {\n    throttler.maybeExecute(newValue)\n  }\n\n  const throttled = Object.assign(() => throttledValue(), {\n    set,\n    throttler,\n  }) as ThrottledSignal<TValue, TSelected>\n\n  return throttled\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+DA,SAAgB,sBACd,OACA,gBACA,UACoC;CACpC,MAAM,2CAAgC,MAAM;CAE5C,MAAM,YAAYA,yCACf,aAAkD;EACjD,IAAI,OAAO,aAAa,YACtB,eAAe,OAAO,SAAqC;OAE3D,eAAe,IAAI,SAAS;IAGhC,gBACA,SACD;CAED,MAAM,OACJ,aACG;EACH,UAAU,aAAa,SAAS;;CAQlC,OALkB,OAAO,aAAa,gBAAgB,EAAE;EACtD;EACA;EACD,CAEe"}

package/dist/throttler/injectThrottledSignal.d.cts

@@ -1,61 +0,0 @@
-import { AngularThrottler } from "./injectThrottler.cjs";
-import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
-
-//#region src/throttler/injectThrottledSignal.d.ts
-type Setter<T> = (value: T | ((prev: T) => T)) => void;
-interface ThrottledSignal<TValue, TSelected = {}> {
-  (): TValue;
-  set: Setter<TValue>;
-  throttler: AngularThrottler<Setter<TValue>, TSelected>;
-}
-/**
- * An Angular function that creates a throttled state signal, combining Angular's signal with throttling functionality.
- * This function provides both the current throttled value and methods to update it.
- *
- * The state value is updated at most once within the specified wait time.
- * This is useful for handling frequent state updates that should be rate-limited, like scroll positions
- * or mouse movements.
- *
- * The function returns a callable object:
- * - `throttled()`: Get the current throttled value
- * - `throttled.set(...)`: Set or update the throttled value (throttled via maybeExecute)
- * - `throttled.throttler`: The throttler instance with additional control methods and state signals
- *
- * ## State Management and Selector
- *
- * The function uses TanStack Store for reactive state management via the underlying throttler instance.
- * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,
- * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
- *
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
- * tracking by providing a selector function. This prevents unnecessary updates and gives you
- * full control over when your component tracks state changes.
- *
- * Available throttler state properties:
- * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
- * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
- * - `executionCount`: Number of function executions that have been completed
- * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
- * - `lastExecutionTime`: Timestamp of the last execution
- * - `nextExecutionTime`: Timestamp of the next allowed execution
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
- *
- * @example
- * ```ts
- * const throttledScrollY = injectThrottledSignal(0, { wait: 100 })
- *
- * // Get value
- * console.log(throttledScrollY())
- *
- * // Set/update value (throttled)
- * throttledScrollY.set(window.scrollY)
- *
- * // Access throttler
- * console.log(throttledScrollY.throttler.state().isPending)
- * ```
- */
-declare function injectThrottledSignal<TValue, TSelected = {}>(value: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): ThrottledSignal<TValue, TSelected>;
-//#endregion
-export { ThrottledSignal, injectThrottledSignal };
-//# sourceMappingURL=injectThrottledSignal.d.cts.map

package/dist/throttler/injectThrottledSignal.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"injectThrottledSignal.js","names":[],"sources":["../../src/throttler/injectThrottledSignal.ts"],"sourcesContent":["import { signal } from '@angular/core'\nimport { injectThrottler } from './injectThrottler'\nimport type { AngularThrottler } from './injectThrottler'\nimport type {\n  ThrottlerOptions,\n  ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\nexport interface ThrottledSignal<TValue, TSelected = {}> {\n  (): TValue\n  set: Setter<TValue>\n  throttler: AngularThrottler<Setter<TValue>, TSelected>\n}\n\n/**\n * An Angular function that creates a throttled state signal, combining Angular's signal with throttling functionality.\n * This function provides both the current throttled value and methods to update it.\n *\n * The state value is updated at most once within the specified wait time.\n * This is useful for handling frequent state updates that should be rate-limited, like scroll positions\n * or mouse movements.\n *\n * The function returns a callable object:\n * - `throttled()`: Get the current throttled value\n * - `throttled.set(...)`: Set or update the throttled value (throttled via maybeExecute)\n * - `throttled.throttler`: The throttler instance with additional control methods and state signals\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```ts\n * const throttledScrollY = injectThrottledSignal(0, { wait: 100 })\n *\n * // Get value\n * console.log(throttledScrollY())\n *\n * // Set/update value (throttled)\n * throttledScrollY.set(window.scrollY)\n *\n * // Access throttler\n * console.log(throttledScrollY.throttler.state().isPending)\n * ```\n */\nexport function injectThrottledSignal<TValue, TSelected = {}>(\n  value: TValue,\n  initialOptions: ThrottlerOptions<Setter<TValue>>,\n  selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected> {\n  const throttledValue = signal<TValue>(value)\n\n  const throttler = injectThrottler(\n    (newValue: TValue | ((prev: TValue) => TValue)) => {\n      if (typeof newValue === 'function') {\n        throttledValue.update(newValue as (prev: TValue) => TValue)\n      } else {\n        throttledValue.set(newValue)\n      }\n    },\n    initialOptions,\n    selector,\n  )\n\n  const set: Setter<TValue> = (\n    newValue: TValue | ((prev: TValue) => TValue),\n  ) => {\n    throttler.maybeExecute(newValue)\n  }\n\n  const throttled = Object.assign(() => throttledValue(), {\n    set,\n    throttler,\n  }) as ThrottledSignal<TValue, TSelected>\n\n  return throttled\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+DA,SAAgB,sBACd,OACA,gBACA,UACoC;CACpC,MAAM,iBAAiB,OAAe,MAAM;CAE5C,MAAM,YAAY,iBACf,aAAkD;EACjD,IAAI,OAAO,aAAa,YACtB,eAAe,OAAO,SAAqC;OAE3D,eAAe,IAAI,SAAS;IAGhC,gBACA,SACD;CAED,MAAM,OACJ,aACG;EACH,UAAU,aAAa,SAAS;;CAQlC,OALkB,OAAO,aAAa,gBAAgB,EAAE;EACtD;EACA;EACD,CAEe"}

package/dist/throttler/injectThrottledValue.cjs

@@ -1,17 +0,0 @@
-const require_injectThrottledSignal = require('./injectThrottledSignal.cjs');
-let _angular_core = require("@angular/core");
-
-//#region src/throttler/injectThrottledValue.ts
-function injectThrottledValue(value, initialValueOrOptions, initialOptionsOrSelector, maybeSelector) {
-	const hasInitialValue = initialOptionsOrSelector !== void 0 && !(typeof initialOptionsOrSelector === "function") || maybeSelector !== void 0;
-	const throttledValue = require_injectThrottledSignal.injectThrottledSignal(hasInitialValue ? initialValueOrOptions : void 0, hasInitialValue ? initialOptionsOrSelector : initialValueOrOptions, hasInitialValue ? maybeSelector : initialOptionsOrSelector);
-	(0, _angular_core.effect)(() => {
-		const latest = value();
-		throttledValue.set(latest);
-	});
-	return throttledValue;
-}
-
-//#endregion
-exports.injectThrottledValue = injectThrottledValue;
-//# sourceMappingURL=injectThrottledValue.cjs.map

package/dist/throttler/injectThrottledValue.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"injectThrottledValue.cjs","names":["injectThrottledSignal"],"sources":["../../src/throttler/injectThrottledValue.ts"],"sourcesContent":["import { effect } from '@angular/core'\nimport { injectThrottledSignal } from './injectThrottledSignal'\nimport type { ThrottledSignal } from './injectThrottledSignal'\nimport type { Signal } from '@angular/core'\nimport type {\n  ThrottlerOptions,\n  ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\n/**\n * An Angular function that creates a throttled value that updates at most once within a specified time window.\n * Unlike injectThrottledSignal, this function automatically tracks changes to the input signal\n * and updates the throttled value accordingly.\n *\n * The throttled value will update at most once within the specified wait time, regardless of\n * how frequently the input value changes.\n *\n * This is useful for deriving throttled values from signals that change frequently,\n * like scroll positions or mouse coordinates, where you want to limit how often downstream effects\n * or calculations occur.\n *\n * The function returns a throttled signal object containing:\n * - A Signal that provides the current throttled value\n * - The throttler instance with control methods\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const scrollY = signal(0)\n * const throttledScrollY = injectThrottledValue(scrollY, {\n *   wait: 100, // Update at most once per 100ms\n * })\n *\n * // Opt-in to reactive updates when pending state changes\n * const throttledScrollYWithState = injectThrottledValue(\n *   scrollY,\n *   { wait: 100 },\n *   (state) => ({ isPending: state.isPending }),\n * )\n *\n * // Read the throttled signal value\n * effect(() => {\n *   updateUI(throttledScrollY())\n * })\n *\n * // Access throttler state via the returned object's state() signal\n * console.log('Is pending:', throttledScrollYWithState.state().isPending)\n *\n * // Control the throttler\n * throttledScrollY.cancel() // Cancel any pending updates\n * ```\n */\nexport function injectThrottledValue<TValue, TSelected = {}>(\n  value: Signal<TValue>,\n  initialOptions: ThrottlerOptions<Setter<TValue>>,\n  selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected>\nexport function injectThrottledValue<TValue, TSelected = {}>(\n  value: Signal<TValue>,\n  initialValue: TValue,\n  initialOptions: ThrottlerOptions<Setter<TValue>>,\n  selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected>\nexport function injectThrottledValue<TValue, TSelected = {}>(\n  value: Signal<TValue>,\n  initialValueOrOptions: TValue | ThrottlerOptions<Setter<TValue>>,\n  initialOptionsOrSelector?:\n    | ThrottlerOptions<Setter<TValue>>\n    | ((state: ThrottlerState<Setter<TValue>>) => TSelected),\n  maybeSelector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected> {\n  const hasSelector = typeof initialOptionsOrSelector === 'function'\n\n  const hasInitialValue =\n    (initialOptionsOrSelector !== undefined && !hasSelector) ||\n    maybeSelector !== undefined\n\n  const initialValue = hasInitialValue\n    ? (initialValueOrOptions as TValue)\n    : (undefined as unknown as TValue)\n  const initialOptions = hasInitialValue\n    ? (initialOptionsOrSelector as ThrottlerOptions<Setter<TValue>>)\n    : (initialValueOrOptions as ThrottlerOptions<Setter<TValue>>)\n  const selector = hasInitialValue\n    ? maybeSelector\n    : (initialOptionsOrSelector as\n        | ((state: ThrottlerState<Setter<TValue>>) => TSelected)\n        | undefined)\n\n  const throttledValue = injectThrottledSignal(\n    initialValue,\n    initialOptions,\n    selector,\n  )\n\n  effect(() => {\n    const latest = value()\n    throttledValue.set(latest)\n  })\n\n  return throttledValue\n}\n"],"mappings":";;;;AAqFA,SAAgB,qBACd,OACA,uBACA,0BAGA,eACoC;CAGpC,MAAM,kBACH,6BAA6B,UAAa,EAHzB,OAAO,6BAA6B,eAItD,kBAAkB;CAcpB,MAAM,iBAAiBA,oDAZF,kBAChB,wBACA,QACkB,kBAClB,2BACA,uBACY,kBACb,gBACC,yBAQJ;CAED,gCAAa;EACX,MAAM,SAAS,OAAO;EACtB,eAAe,IAAI,OAAO;GAC1B;CAEF,OAAO"}

package/dist/throttler/injectThrottledValue.d.cts

@@ -1,74 +0,0 @@
-import { ThrottledSignal } from "./injectThrottledSignal.cjs";
-import { Signal } from "@angular/core";
-import { ThrottlerOptions, ThrottlerState } from "@tanstack/pacer/throttler";
-
-//#region src/throttler/injectThrottledValue.d.ts
-type Setter<T> = (value: T | ((prev: T) => T)) => void;
-/**
- * An Angular function that creates a throttled value that updates at most once within a specified time window.
- * Unlike injectThrottledSignal, this function automatically tracks changes to the input signal
- * and updates the throttled value accordingly.
- *
- * The throttled value will update at most once within the specified wait time, regardless of
- * how frequently the input value changes.
- *
- * This is useful for deriving throttled values from signals that change frequently,
- * like scroll positions or mouse coordinates, where you want to limit how often downstream effects
- * or calculations occur.
- *
- * The function returns a throttled signal object containing:
- * - A Signal that provides the current throttled value
- * - The throttler instance with control methods
- *
- * ## State Management and Selector
- *
- * The function uses TanStack Store for reactive state management via the underlying throttler instance.
- * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,
- * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.
- *
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
- * tracking by providing a selector function. This prevents unnecessary updates and gives you
- * full control over when your component tracks state changes.
- *
- * Available throttler state properties:
- * - `canLeadingExecute`: Whether the throttler can execute on the leading edge
- * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
- * - `executionCount`: Number of function executions that have been completed
- * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
- * - `lastExecutionTime`: Timestamp of the last execution
- * - `nextExecutionTime`: Timestamp of the next allowed execution
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
- *
- * @example
- * ```ts
- * // Default behavior - no reactive state subscriptions
- * const scrollY = signal(0)
- * const throttledScrollY = injectThrottledValue(scrollY, {
- *   wait: 100, // Update at most once per 100ms
- * })
- *
- * // Opt-in to reactive updates when pending state changes
- * const throttledScrollYWithState = injectThrottledValue(
- *   scrollY,
- *   { wait: 100 },
- *   (state) => ({ isPending: state.isPending }),
- * )
- *
- * // Read the throttled signal value
- * effect(() => {
- *   updateUI(throttledScrollY())
- * })
- *
- * // Access throttler state via the returned object's state() signal
- * console.log('Is pending:', throttledScrollYWithState.state().isPending)
- *
- * // Control the throttler
- * throttledScrollY.cancel() // Cancel any pending updates
- * ```
- */
-declare function injectThrottledValue<TValue, TSelected = {}>(value: Signal<TValue>, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): ThrottledSignal<TValue, TSelected>;
-declare function injectThrottledValue<TValue, TSelected = {}>(value: Signal<TValue>, initialValue: TValue, initialOptions: ThrottlerOptions<Setter<TValue>>, selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected): ThrottledSignal<TValue, TSelected>;
-//#endregion
-export { injectThrottledValue };
-//# sourceMappingURL=injectThrottledValue.d.cts.map

package/dist/throttler/injectThrottledValue.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"injectThrottledValue.js","names":[],"sources":["../../src/throttler/injectThrottledValue.ts"],"sourcesContent":["import { effect } from '@angular/core'\nimport { injectThrottledSignal } from './injectThrottledSignal'\nimport type { ThrottledSignal } from './injectThrottledSignal'\nimport type { Signal } from '@angular/core'\nimport type {\n  ThrottlerOptions,\n  ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\ntype Setter<T> = (value: T | ((prev: T) => T)) => void\n\n/**\n * An Angular function that creates a throttled value that updates at most once within a specified time window.\n * Unlike injectThrottledSignal, this function automatically tracks changes to the input signal\n * and updates the throttled value accordingly.\n *\n * The throttled value will update at most once within the specified wait time, regardless of\n * how frequently the input value changes.\n *\n * This is useful for deriving throttled values from signals that change frequently,\n * like scroll positions or mouse coordinates, where you want to limit how often downstream effects\n * or calculations occur.\n *\n * The function returns a throttled signal object containing:\n * - A Signal that provides the current throttled value\n * - The throttler instance with control methods\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for reactive state management via the underlying throttler instance.\n * The `selector` parameter allows you to specify which throttler state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * Available throttler state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const scrollY = signal(0)\n * const throttledScrollY = injectThrottledValue(scrollY, {\n *   wait: 100, // Update at most once per 100ms\n * })\n *\n * // Opt-in to reactive updates when pending state changes\n * const throttledScrollYWithState = injectThrottledValue(\n *   scrollY,\n *   { wait: 100 },\n *   (state) => ({ isPending: state.isPending }),\n * )\n *\n * // Read the throttled signal value\n * effect(() => {\n *   updateUI(throttledScrollY())\n * })\n *\n * // Access throttler state via the returned object's state() signal\n * console.log('Is pending:', throttledScrollYWithState.state().isPending)\n *\n * // Control the throttler\n * throttledScrollY.cancel() // Cancel any pending updates\n * ```\n */\nexport function injectThrottledValue<TValue, TSelected = {}>(\n  value: Signal<TValue>,\n  initialOptions: ThrottlerOptions<Setter<TValue>>,\n  selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected>\nexport function injectThrottledValue<TValue, TSelected = {}>(\n  value: Signal<TValue>,\n  initialValue: TValue,\n  initialOptions: ThrottlerOptions<Setter<TValue>>,\n  selector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected>\nexport function injectThrottledValue<TValue, TSelected = {}>(\n  value: Signal<TValue>,\n  initialValueOrOptions: TValue | ThrottlerOptions<Setter<TValue>>,\n  initialOptionsOrSelector?:\n    | ThrottlerOptions<Setter<TValue>>\n    | ((state: ThrottlerState<Setter<TValue>>) => TSelected),\n  maybeSelector?: (state: ThrottlerState<Setter<TValue>>) => TSelected,\n): ThrottledSignal<TValue, TSelected> {\n  const hasSelector = typeof initialOptionsOrSelector === 'function'\n\n  const hasInitialValue =\n    (initialOptionsOrSelector !== undefined && !hasSelector) ||\n    maybeSelector !== undefined\n\n  const initialValue = hasInitialValue\n    ? (initialValueOrOptions as TValue)\n    : (undefined as unknown as TValue)\n  const initialOptions = hasInitialValue\n    ? (initialOptionsOrSelector as ThrottlerOptions<Setter<TValue>>)\n    : (initialValueOrOptions as ThrottlerOptions<Setter<TValue>>)\n  const selector = hasInitialValue\n    ? maybeSelector\n    : (initialOptionsOrSelector as\n        | ((state: ThrottlerState<Setter<TValue>>) => TSelected)\n        | undefined)\n\n  const throttledValue = injectThrottledSignal(\n    initialValue,\n    initialOptions,\n    selector,\n  )\n\n  effect(() => {\n    const latest = value()\n    throttledValue.set(latest)\n  })\n\n  return throttledValue\n}\n"],"mappings":";;;;AAqFA,SAAgB,qBACd,OACA,uBACA,0BAGA,eACoC;CAGpC,MAAM,kBACH,6BAA6B,UAAa,EAHzB,OAAO,6BAA6B,eAItD,kBAAkB;CAcpB,MAAM,iBAAiB,sBAZF,kBAChB,wBACA,QACkB,kBAClB,2BACA,uBACY,kBACb,gBACC,yBAQJ;CAED,aAAa;EACX,MAAM,SAAS,OAAO;EACtB,eAAe,IAAI,OAAO;GAC1B;CAEF,OAAO"}

package/dist/throttler/injectThrottler.cjs

@@ -1,95 +0,0 @@
-const require_pacer_context = require('../provider/pacer-context.cjs');
-let _angular_core = require("@angular/core");
-let _tanstack_angular_store = require("@tanstack/angular-store");
-let _tanstack_pacer_throttler = require("@tanstack/pacer/throttler");
-
-//#region src/throttler/injectThrottler.ts
-/**
-* An Angular function that creates and manages a Throttler instance.
-*
-* This is a lower-level function that provides direct access to the Throttler's functionality.
-* This allows you to integrate it with any state management solution you prefer.
-*
-* This function provides throttling functionality to limit how often a function can be called,
-* ensuring it executes at most once within a specified time window.
-*
-* The throttler will execute the function immediately (if leading is enabled) and then
-* prevent further executions until the wait period has elapsed.
-*
-* ## State Management and Selector
-*
-* The function uses TanStack Store for state management and wraps it with Angular signals.
-* The `selector` parameter allows you to specify which state changes will trigger signal updates,
-* optimizing performance by preventing unnecessary updates when irrelevant state changes occur.
-*
-* **By default, there will be no reactive state subscriptions** and you must opt-in to state
-* tracking by providing a selector function. This prevents unnecessary updates and gives you
-* full control over when your component tracks state changes.
-*
-* Available state properties:
-* - `canLeadingExecute`: Whether the throttler can execute on the leading edge
-* - `canTrailingExecute`: Whether the throttler can execute on the trailing edge
-* - `executionCount`: Number of function executions that have been completed
-* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
-* - `lastArgs`: The arguments from the most recent call to maybeExecute
-* - `lastExecutionTime`: Timestamp of the last execution
-* - `nextExecutionTime`: Timestamp of the next allowed execution
-* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
-*
-* ## Cleanup on Destroy
-*
-* By default, the function cancels any pending execution when the component is destroyed.
-* Use the `onUnmount` option to customize this. For example, to flush pending work instead:
-*
-* ```ts
-* const throttler = injectThrottler(fn, {
-*   wait: 100,
-*   onUnmount: (t) => t.flush()
-* });
-* ```
-*
-* @example
-* ```ts
-* // Default behavior - no reactive state subscriptions
-* const throttler = injectThrottler(
-*   (scrollY: number) => updateScrollPosition(scrollY),
-*   { wait: 100 }
-* );
-*
-* // Opt-in to track isPending changes (optimized for loading states)
-* const throttler = injectThrottler(
-*   (scrollY: number) => updateScrollPosition(scrollY),
-*   { wait: 100 },
-*   (state) => ({ isPending: state.isPending })
-* );
-*
-* // In an event handler
-* window.addEventListener('scroll', () => {
-*   throttler.maybeExecute(window.scrollY);
-* });
-*
-* // Access the selected state (will be empty object {} unless selector provided)
-* const { isPending } = throttler.state();
-* ```
-*/
-function injectThrottler(fn, options, selector = () => ({})) {
-	const mergedOptions = {
-		...require_pacer_context.injectPacerOptions().throttler,
-		...options
-	};
-	const throttler = new _tanstack_pacer_throttler.Throttler(fn, mergedOptions);
-	const state = (0, _tanstack_angular_store.injectSelector)(throttler.store, selector);
-	const result = {
-		...throttler,
-		state
-	};
-	(0, _angular_core.inject)(_angular_core.DestroyRef, { optional: true })?.onDestroy(() => {
-		if (mergedOptions.onUnmount) mergedOptions.onUnmount(result);
-		else throttler.cancel();
-	});
-	return result;
-}
-
-//#endregion
-exports.injectThrottler = injectThrottler;
-//# sourceMappingURL=injectThrottler.cjs.map

package/dist/throttler/injectThrottler.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"injectThrottler.cjs","names":["injectPacerOptions","Throttler","DestroyRef"],"sources":["../../src/throttler/injectThrottler.ts"],"sourcesContent":["import { DestroyRef, inject } from '@angular/core'\nimport { injectSelector } from '@tanstack/angular-store'\nimport { Throttler } from '@tanstack/pacer/throttler'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/angular-store'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n  ThrottlerOptions,\n  ThrottlerState,\n} from '@tanstack/pacer/throttler'\n\nexport interface AngularThrottlerOptions<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends ThrottlerOptions<TFn> {\n  /**\n   * Optional callback invoked when the component is destroyed. Receives the throttler instance.\n   * When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc.\n   */\n  onUnmount?: (throttler: AngularThrottler<TFn, TSelected>) => void\n}\n\nexport interface AngularThrottler<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Throttler<TFn>, 'store'> {\n  /**\n   * Reactive state signal that will be updated when the throttler state changes\n   *\n   * Use this instead of `throttler.store.state`\n   */\n  readonly state: Signal<Readonly<TSelected>>\n  /**\n   * @deprecated Use `throttler.state` instead of `throttler.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive in Angular signals.\n   */\n  readonly store: Store<Readonly<ThrottlerState<TFn>>>\n}\n\n/**\n * An Angular function that creates and manages a Throttler instance.\n *\n * This is a lower-level function that provides direct access to the Throttler's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * This function provides throttling functionality to limit how often a function can be called,\n * ensuring it executes at most once within a specified time window.\n *\n * The throttler will execute the function immediately (if leading is enabled) and then\n * prevent further executions until the wait period has elapsed.\n *\n * ## State Management and Selector\n *\n * The function uses TanStack Store for state management and wraps it with Angular signals.\n * The `selector` parameter allows you to specify which state changes will trigger signal updates,\n * optimizing performance by preventing unnecessary updates when irrelevant state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function. This prevents unnecessary updates and gives you\n * full control over when your component tracks state changes.\n *\n * Available state properties:\n * - `canLeadingExecute`: Whether the throttler can execute on the leading edge\n * - `canTrailingExecute`: Whether the throttler can execute on the trailing edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last execution\n * - `nextExecutionTime`: Timestamp of the next allowed execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * ## Cleanup on Destroy\n *\n * By default, the function cancels any pending execution when the component is destroyed.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```ts\n * const throttler = injectThrottler(fn, {\n *   wait: 100,\n *   onUnmount: (t) => t.flush()\n * });\n * ```\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const throttler = injectThrottler(\n *   (scrollY: number) => updateScrollPosition(scrollY),\n *   { wait: 100 }\n * );\n *\n * // Opt-in to track isPending changes (optimized for loading states)\n * const throttler = injectThrottler(\n *   (scrollY: number) => updateScrollPosition(scrollY),\n *   { wait: 100 },\n *   (state) => ({ isPending: state.isPending })\n * );\n *\n * // In an event handler\n * window.addEventListener('scroll', () => {\n *   throttler.maybeExecute(window.scrollY);\n * });\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending } = throttler.state();\n * ```\n */\nexport function injectThrottler<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: AngularThrottlerOptions<TFn, TSelected>,\n  selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): AngularThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...injectPacerOptions().throttler,\n    ...options,\n  } as AngularThrottlerOptions<TFn, TSelected>\n\n  const throttler = new Throttler<TFn>(fn, mergedOptions)\n  const state = injectSelector(throttler.store, selector)\n\n  const result = {\n    ...throttler,\n    state,\n  } as AngularThrottler<TFn, TSelected>\n\n  const destroyRef = inject(DestroyRef, { optional: true })\n  destroyRef?.onDestroy(() => {\n    if (mergedOptions.onUnmount) {\n      mergedOptions.onUnmount(result)\n    } else {\n      throttler.cancel()\n    }\n  })\n\n  return result\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4GA,SAAgB,gBACd,IACA,SACA,kBAA6D,EAAE,GAC7B;CAClC,MAAM,gBAAgB;EACpB,GAAGA,0CAAoB,CAAC;EACxB,GAAG;EACJ;CAED,MAAM,YAAY,IAAIC,oCAAe,IAAI,cAAc;CACvD,MAAM,oDAAuB,UAAU,OAAO,SAAS;CAEvD,MAAM,SAAS;EACb,GAAG;EACH;EACD;CAGD,0BAD0BC,0BAAY,EAAE,UAAU,MAAM,CAC9C,EAAE,gBAAgB;EAC1B,IAAI,cAAc,WAChB,cAAc,UAAU,OAAO;OAE/B,UAAU,QAAQ;GAEpB;CAEF,OAAO"}