@tanstack/angular-pacer 0.20.0 → 0.21.0

package/dist/async-throttler/injectAsyncThrottler.d.cts

@@ -1,9 +1,17 @@
 import { Signal } from "@angular/core";
-import { Store } from "@tanstack/store";
+import { Store } from "@tanstack/angular-store";
 import { AnyAsyncFunction } from "@tanstack/pacer/types";
 import { AsyncThrottler, AsyncThrottlerOptions, AsyncThrottlerState } from "@tanstack/pacer/async-throttler";
 
 //#region src/async-throttler/injectAsyncThrottler.d.ts
+interface AngularAsyncThrottlerOptions<TFn extends AnyAsyncFunction, TSelected = {}> extends AsyncThrottlerOptions<TFn> {
+  /**
+   * Optional callback invoked when the component is destroyed. Receives the throttler instance.
+   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), cancel(), add logging, etc.
+   * When using onUnmount with flush, guard your callbacks since the component may already be destroyed.
+   */
+  onUnmount?: (throttler: AngularAsyncThrottler<TFn, TSelected>) => void;
+}
 interface AngularAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncThrottler<TFn>, 'store'> {
   /**
    * Reactive state signal that will be updated when the async throttler state changes
@@ -38,6 +46,20 @@ interface AngularAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}> ex
  * tracking by providing a selector function. This prevents unnecessary updates and gives you
  * full control over when your component tracks state changes.
  *
+ * ## Cleanup on Destroy
+ *
+ * By default, the function cancels any pending execution and aborts in-flight work when the component is destroyed.
+ * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+ *
+ * ```ts
+ * const throttler = injectAsyncThrottler(fn, {
+ *   wait: 1000,
+ *   onUnmount: (t) => t.flush()
+ * });
+ * ```
+ *
+ * When using onUnmount with flush, guard your callbacks since the component may already be destroyed.
+ *
  * @example
  * ```ts
  * // Default behavior - no reactive state subscriptions
@@ -59,7 +81,7 @@ interface AngularAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}> ex
  * };
  * ```
  */
-declare function injectAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncThrottlerOptions<TFn>, selector?: (state: AsyncThrottlerState<TFn>) => TSelected): AngularAsyncThrottler<TFn, TSelected>;
+declare function injectAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AngularAsyncThrottlerOptions<TFn, TSelected>, selector?: (state: AsyncThrottlerState<TFn>) => TSelected): AngularAsyncThrottler<TFn, TSelected>;
 //#endregion
-export { AngularAsyncThrottler, injectAsyncThrottler };
+export { AngularAsyncThrottler, AngularAsyncThrottlerOptions, injectAsyncThrottler };
 //# sourceMappingURL=injectAsyncThrottler.d.cts.map

package/dist/async-throttler/injectAsyncThrottler.d.ts

@@ -1,9 +1,17 @@
 import { Signal } from "@angular/core";
+import { Store } from "@tanstack/angular-store";
 import { AsyncThrottler, AsyncThrottlerOptions, AsyncThrottlerState } from "@tanstack/pacer/async-throttler";
 import { AnyAsyncFunction } from "@tanstack/pacer/types";
-import { Store } from "@tanstack/store";
 
 //#region src/async-throttler/injectAsyncThrottler.d.ts
+interface AngularAsyncThrottlerOptions<TFn extends AnyAsyncFunction, TSelected = {}> extends AsyncThrottlerOptions<TFn> {
+  /**
+   * Optional callback invoked when the component is destroyed. Receives the throttler instance.
+   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), cancel(), add logging, etc.
+   * When using onUnmount with flush, guard your callbacks since the component may already be destroyed.
+   */
+  onUnmount?: (throttler: AngularAsyncThrottler<TFn, TSelected>) => void;
+}
 interface AngularAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncThrottler<TFn>, 'store'> {
   /**
    * Reactive state signal that will be updated when the async throttler state changes
@@ -38,6 +46,20 @@ interface AngularAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}> ex
  * tracking by providing a selector function. This prevents unnecessary updates and gives you
  * full control over when your component tracks state changes.
  *
+ * ## Cleanup on Destroy
+ *
+ * By default, the function cancels any pending execution and aborts in-flight work when the component is destroyed.
+ * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+ *
+ * ```ts
+ * const throttler = injectAsyncThrottler(fn, {
+ *   wait: 1000,
+ *   onUnmount: (t) => t.flush()
+ * });
+ * ```
+ *
+ * When using onUnmount with flush, guard your callbacks since the component may already be destroyed.
+ *
  * @example
  * ```ts
  * // Default behavior - no reactive state subscriptions
@@ -59,7 +81,7 @@ interface AngularAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}> ex
  * };
  * ```
  */
-declare function injectAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AsyncThrottlerOptions<TFn>, selector?: (state: AsyncThrottlerState<TFn>) => TSelected): AngularAsyncThrottler<TFn, TSelected>;
+declare function injectAsyncThrottler<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: AngularAsyncThrottlerOptions<TFn, TSelected>, selector?: (state: AsyncThrottlerState<TFn>) => TSelected): AngularAsyncThrottler<TFn, TSelected>;
 //#endregion
-export { AngularAsyncThrottler, injectAsyncThrottler };
+export { AngularAsyncThrottler, AngularAsyncThrottlerOptions, injectAsyncThrottler };
 //# sourceMappingURL=injectAsyncThrottler.d.ts.map

package/dist/async-throttler/injectAsyncThrottler.js

@@ -1,4 +1,5 @@
 import { injectPacerOptions } from "../provider/pacer-context.js";
+import { DestroyRef, inject } from "@angular/core";
 import { injectStore } from "@tanstack/angular-store";
 import { AsyncThrottler } from "@tanstack/pacer/async-throttler";
 
@@ -24,6 +25,20 @@ import { AsyncThrottler } from "@tanstack/pacer/async-throttler";
 * tracking by providing a selector function. This prevents unnecessary updates and gives you
 * full control over when your component tracks state changes.
 *
+* ## Cleanup on Destroy
+*
+* By default, the function cancels any pending execution and aborts in-flight work when the component is destroyed.
+* Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+*
+* ```ts
+* const throttler = injectAsyncThrottler(fn, {
+*   wait: 1000,
+*   onUnmount: (t) => t.flush()
+* });
+* ```
+*
+* When using onUnmount with flush, guard your callbacks since the component may already be destroyed.
+*
 * @example
 * ```ts
 * // Default behavior - no reactive state subscriptions
@@ -46,15 +61,24 @@ import { AsyncThrottler } from "@tanstack/pacer/async-throttler";
 * ```
 */
 function injectAsyncThrottler(fn, options, selector = () => ({})) {
-	const throttler = new AsyncThrottler(fn, {
+	const mergedOptions = {
 		...injectPacerOptions().asyncThrottler,
 		...options
-	});
+	};
+	const throttler = new AsyncThrottler(fn, mergedOptions);
 	const state = injectStore(throttler.store, selector);
-	return {
+	const result = {
 		...throttler,
 		state
 	};
+	inject(DestroyRef, { optional: true })?.onDestroy(() => {
+		if (mergedOptions.onUnmount) mergedOptions.onUnmount(result);
+		else {
+			throttler.cancel();
+			throttler.abort();
+		}
+	});
+	return result;
 }
 
 //#endregion

package/dist/async-throttler/injectAsyncThrottler.js.map

@@ -1 +1 @@
-{"version":3,"file":"injectAsyncThrottler.js","names":[],"sources":["../../src/async-throttler/injectAsyncThrottler.ts"],"sourcesContent":["import { injectStore } from '@tanstack/angular-store'\nimport { AsyncThrottler } from '@tanstack/pacer/async-throttler'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncThrottlerOptions,\n  AsyncThrottlerState,\n} from '@tanstack/pacer/async-throttler'\n\nexport interface AngularAsyncThrottler<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncThrottler<TFn>, 'store'> {\n  /**\n   * Reactive state signal that will be updated when the async 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<AsyncThrottlerState<TFn>>>\n}\n\n/**\n * An Angular function that creates and manages an AsyncThrottler instance.\n *\n * This is a lower-level function that provides direct access to the AsyncThrottler's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * This function provides async throttling functionality with promise support, error handling,\n * retry capabilities, and abort support.\n *\n * The throttler will execute the function at most once within the specified wait time.\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 * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const throttler = injectAsyncThrottler(\n *   async (data: Data) => {\n *     const response = await fetch('/api/update', {\n *       method: 'POST',\n *       body: JSON.stringify(data)\n *     });\n *     return response.json();\n *   },\n *   { wait: 1000 }\n * );\n *\n * // In an event handler\n * const handleUpdate = async (data: Data) => {\n *   const result = await throttler.maybeExecute(data);\n *   console.log('Update result:', result);\n * };\n * ```\n */\nexport function injectAsyncThrottler<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: AsyncThrottlerOptions<TFn>,\n  selector: (state: AsyncThrottlerState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): AngularAsyncThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...injectPacerOptions().asyncThrottler,\n    ...options,\n  } as AsyncThrottlerOptions<TFn>\n\n  const throttler = new AsyncThrottler<TFn>(fn, mergedOptions)\n  const state = injectStore(throttler.store, selector)\n\n  return {\n    ...throttler,\n    state,\n  } as AngularAsyncThrottler<TFn, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsEA,SAAgB,qBAId,IACA,SACA,kBACG,EAAE,GACkC;CAMvC,MAAM,YAAY,IAAI,eAAoB,IALpB;EACpB,GAAG,oBAAoB,CAAC;EACxB,GAAG;EACJ,CAE2D;CAC5D,MAAM,QAAQ,YAAY,UAAU,OAAO,SAAS;AAEpD,QAAO;EACL,GAAG;EACH;EACD"}
+{"version":3,"file":"injectAsyncThrottler.js","names":[],"sources":["../../src/async-throttler/injectAsyncThrottler.ts"],"sourcesContent":["import { DestroyRef, inject } from '@angular/core'\nimport { injectStore } from '@tanstack/angular-store'\nimport { AsyncThrottler } from '@tanstack/pacer/async-throttler'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/angular-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncThrottlerOptions,\n  AsyncThrottlerState,\n} from '@tanstack/pacer/async-throttler'\n\nexport interface AngularAsyncThrottlerOptions<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends AsyncThrottlerOptions<TFn> {\n  /**\n   * Optional callback invoked when the component is destroyed. Receives the throttler instance.\n   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), cancel(), add logging, etc.\n   * When using onUnmount with flush, guard your callbacks since the component may already be destroyed.\n   */\n  onUnmount?: (throttler: AngularAsyncThrottler<TFn, TSelected>) => void\n}\n\nexport interface AngularAsyncThrottler<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncThrottler<TFn>, 'store'> {\n  /**\n   * Reactive state signal that will be updated when the async 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<AsyncThrottlerState<TFn>>>\n}\n\n/**\n * An Angular function that creates and manages an AsyncThrottler instance.\n *\n * This is a lower-level function that provides direct access to the AsyncThrottler's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * This function provides async throttling functionality with promise support, error handling,\n * retry capabilities, and abort support.\n *\n * The throttler will execute the function at most once within the specified wait time.\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 * ## Cleanup on Destroy\n *\n * By default, the function cancels any pending execution and aborts in-flight work 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 = injectAsyncThrottler(fn, {\n *   wait: 1000,\n *   onUnmount: (t) => t.flush()\n * });\n * ```\n *\n * When using onUnmount with flush, guard your callbacks since the component may already be destroyed.\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const throttler = injectAsyncThrottler(\n *   async (data: Data) => {\n *     const response = await fetch('/api/update', {\n *       method: 'POST',\n *       body: JSON.stringify(data)\n *     });\n *     return response.json();\n *   },\n *   { wait: 1000 }\n * );\n *\n * // In an event handler\n * const handleUpdate = async (data: Data) => {\n *   const result = await throttler.maybeExecute(data);\n *   console.log('Update result:', result);\n * };\n * ```\n */\nexport function injectAsyncThrottler<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: AngularAsyncThrottlerOptions<TFn, TSelected>,\n  selector: (state: AsyncThrottlerState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): AngularAsyncThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...injectPacerOptions().asyncThrottler,\n    ...options,\n  } as AngularAsyncThrottlerOptions<TFn, TSelected>\n\n  const throttler = new AsyncThrottler<TFn>(fn, mergedOptions)\n  const state = injectStore(throttler.store, selector)\n\n  const result = {\n    ...throttler,\n    state,\n  } as AngularAsyncThrottler<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      throttler.abort()\n    }\n  })\n\n  return result\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiGA,SAAgB,qBAId,IACA,SACA,kBACG,EAAE,GACkC;CACvC,MAAM,gBAAgB;EACpB,GAAG,oBAAoB,CAAC;EACxB,GAAG;EACJ;CAED,MAAM,YAAY,IAAI,eAAoB,IAAI,cAAc;CAC5D,MAAM,QAAQ,YAAY,UAAU,OAAO,SAAS;CAEpD,MAAM,SAAS;EACb,GAAG;EACH;EACD;AAGD,CADmB,OAAO,YAAY,EAAE,UAAU,MAAM,CAAC,EAC7C,gBAAgB;AAC1B,MAAI,cAAc,UAChB,eAAc,UAAU,OAAO;OAC1B;AACL,aAAU,QAAQ;AAClB,aAAU,OAAO;;GAEnB;AAEF,QAAO"}

package/dist/batcher/index.d.cts

@@ -1,4 +1,4 @@
 import { injectBatchedCallback } from "./injectBatchedCallback.cjs";
-import { AngularBatcher, injectBatcher } from "./injectBatcher.cjs";
+import { AngularBatcher, AngularBatcherOptions, injectBatcher } from "./injectBatcher.cjs";
 export * from "@tanstack/pacer/batcher";
-export { AngularBatcher, injectBatchedCallback, injectBatcher };
+export { AngularBatcher, AngularBatcherOptions, injectBatchedCallback, injectBatcher };

package/dist/batcher/index.d.ts

@@ -1,4 +1,4 @@
 import { injectBatchedCallback } from "./injectBatchedCallback.js";
-import { AngularBatcher, injectBatcher } from "./injectBatcher.js";
+import { AngularBatcher, AngularBatcherOptions, injectBatcher } from "./injectBatcher.js";
 export * from "@tanstack/pacer/batcher";
-export { AngularBatcher, injectBatchedCallback, injectBatcher };
+export { AngularBatcher, AngularBatcherOptions, injectBatchedCallback, injectBatcher };

package/dist/batcher/injectBatcher.cjs

@@ -1,4 +1,5 @@
 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_batcher = require("@tanstack/pacer/batcher");
 
@@ -24,6 +25,18 @@ let _tanstack_pacer_batcher = require("@tanstack/pacer/batcher");
 * tracking by providing a selector function. This prevents unnecessary updates and gives you
 * full control over when your component tracks state changes.
 *
+* ## Cleanup on Destroy
+*
+* By default, the function cancels any pending batch when the component is destroyed.
+* Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+*
+* ```ts
+* const batcher = injectBatcher(fn, {
+*   maxSize: 5,
+*   onUnmount: (b) => b.flush()
+* });
+* ```
+*
 * @example
 * ```ts
 * // Default behavior - no reactive state subscriptions
@@ -40,15 +53,21 @@ let _tanstack_pacer_batcher = require("@tanstack/pacer/batcher");
 * ```
 */
 function injectBatcher(fn, options = {}, selector = () => ({})) {
-	const batcher = new _tanstack_pacer_batcher.Batcher(fn, {
+	const mergedOptions = {
 		...require_pacer_context.injectPacerOptions().batcher,
 		...options
-	});
+	};
+	const batcher = new _tanstack_pacer_batcher.Batcher(fn, mergedOptions);
 	const state = (0, _tanstack_angular_store.injectStore)(batcher.store, selector);
-	return {
+	const result = {
 		...batcher,
 		state
 	};
+	(0, _angular_core.inject)(_angular_core.DestroyRef, { optional: true })?.onDestroy(() => {
+		if (mergedOptions.onUnmount) mergedOptions.onUnmount(result);
+		else batcher.cancel();
+	});
+	return result;
 }
 
 //#endregion

package/dist/batcher/injectBatcher.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"injectBatcher.cjs","names":["Batcher","injectPacerOptions"],"sources":["../../src/batcher/injectBatcher.ts"],"sourcesContent":["import { injectStore } from '@tanstack/angular-store'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\n\nexport interface AngularBatcher<TValue, TSelected = {}> extends Omit<\n  Batcher<TValue>,\n  'store'\n> {\n  /**\n   * Reactive state signal that will be updated when the batcher state changes\n   *\n   * Use this instead of `batcher.store.state`\n   */\n  readonly state: Signal<Readonly<TSelected>>\n  /**\n   * @deprecated Use `batcher.state` instead of `batcher.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<BatcherState<TValue>>>\n}\n\n/**\n * An Angular function that creates and manages a Batcher instance.\n *\n * This is a lower-level function that provides direct access to the Batcher's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\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 * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const batcher = injectBatcher(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 }\n * );\n *\n * // Add items\n * batcher.addItem('task1');\n *\n * // Access the selected state\n * const { items, isPending } = batcher.state();\n * ```\n */\nexport function injectBatcher<TValue, TSelected = {}>(\n  fn: (items: Array<TValue>) => void,\n  options: BatcherOptions<TValue> = {},\n  selector: (state: BatcherState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): AngularBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...injectPacerOptions().batcher,\n    ...options,\n  } as BatcherOptions<TValue>\n\n  const batcher = new Batcher<TValue>(fn, mergedOptions)\n  const state = injectStore(batcher.store, selector)\n\n  return {\n    ...batcher,\n    state,\n  } as AngularBatcher<TValue, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4DA,SAAgB,cACd,IACA,UAAkC,EAAE,EACpC,kBACG,EAAE,GAC8B;CAMnC,MAAM,UAAU,IAAIA,gCAAgB,IALd;EACpB,GAAGC,0CAAoB,CAAC;EACxB,GAAG;EACJ,CAEqD;CACtD,MAAM,iDAAoB,QAAQ,OAAO,SAAS;AAElD,QAAO;EACL,GAAG;EACH;EACD"}
+{"version":3,"file":"injectBatcher.cjs","names":["injectPacerOptions","Batcher","DestroyRef"],"sources":["../../src/batcher/injectBatcher.ts"],"sourcesContent":["import { DestroyRef, inject } from '@angular/core'\nimport { injectStore } from '@tanstack/angular-store'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/angular-store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\n\nexport interface AngularBatcherOptions<\n  TValue,\n  TSelected = {},\n> extends BatcherOptions<TValue> {\n  /**\n   * Optional callback invoked when the component is destroyed. Receives the batcher instance.\n   * When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc.\n   */\n  onUnmount?: (batcher: AngularBatcher<TValue, TSelected>) => void\n}\n\nexport interface AngularBatcher<TValue, TSelected = {}> extends Omit<\n  Batcher<TValue>,\n  'store'\n> {\n  /**\n   * Reactive state signal that will be updated when the batcher state changes\n   *\n   * Use this instead of `batcher.store.state`\n   */\n  readonly state: Signal<Readonly<TSelected>>\n  /**\n   * @deprecated Use `batcher.state` instead of `batcher.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<BatcherState<TValue>>>\n}\n\n/**\n * An Angular function that creates and manages a Batcher instance.\n *\n * This is a lower-level function that provides direct access to the Batcher's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\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 * ## Cleanup on Destroy\n *\n * By default, the function cancels any pending batch 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 batcher = injectBatcher(fn, {\n *   maxSize: 5,\n *   onUnmount: (b) => b.flush()\n * });\n * ```\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const batcher = injectBatcher(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 }\n * );\n *\n * // Add items\n * batcher.addItem('task1');\n *\n * // Access the selected state\n * const { items, isPending } = batcher.state();\n * ```\n */\nexport function injectBatcher<TValue, TSelected = {}>(\n  fn: (items: Array<TValue>) => void,\n  options: AngularBatcherOptions<TValue, TSelected> = {},\n  selector: (state: BatcherState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): AngularBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...injectPacerOptions().batcher,\n    ...options,\n  } as AngularBatcherOptions<TValue, TSelected>\n\n  const batcher = new Batcher<TValue>(fn, mergedOptions)\n  const state = injectStore(batcher.store, selector)\n\n  const result = {\n    ...batcher,\n    state,\n  } as AngularBatcher<TValue, TSelected>\n\n  const destroyRef = inject(DestroyRef, { optional: true })\n  destroyRef?.onDestroy(() => {\n    if (mergedOptions.onUnmount) {\n      mergedOptions.onUnmount(result)\n    } else {\n      batcher.cancel()\n    }\n  })\n\n  return result\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoFA,SAAgB,cACd,IACA,UAAoD,EAAE,EACtD,kBACG,EAAE,GAC8B;CACnC,MAAM,gBAAgB;EACpB,GAAGA,0CAAoB,CAAC;EACxB,GAAG;EACJ;CAED,MAAM,UAAU,IAAIC,gCAAgB,IAAI,cAAc;CACtD,MAAM,iDAAoB,QAAQ,OAAO,SAAS;CAElD,MAAM,SAAS;EACb,GAAG;EACH;EACD;AAGD,2BAD0BC,0BAAY,EAAE,UAAU,MAAM,CAAC,EAC7C,gBAAgB;AAC1B,MAAI,cAAc,UAChB,eAAc,UAAU,OAAO;MAE/B,SAAQ,QAAQ;GAElB;AAEF,QAAO"}

package/dist/batcher/injectBatcher.d.cts

@@ -1,8 +1,15 @@
 import { Signal } from "@angular/core";
-import { Store } from "@tanstack/store";
+import { Store } from "@tanstack/angular-store";
 import { Batcher, BatcherOptions, BatcherState } from "@tanstack/pacer/batcher";
 
 //#region src/batcher/injectBatcher.d.ts
+interface AngularBatcherOptions<TValue, TSelected = {}> extends BatcherOptions<TValue> {
+  /**
+   * Optional callback invoked when the component is destroyed. Receives the batcher instance.
+   * When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc.
+   */
+  onUnmount?: (batcher: AngularBatcher<TValue, TSelected>) => void;
+}
 interface AngularBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 'store'> {
   /**
    * Reactive state signal that will be updated when the batcher state changes
@@ -37,6 +44,18 @@ interface AngularBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, '
  * tracking by providing a selector function. This prevents unnecessary updates and gives you
  * full control over when your component tracks state changes.
  *
+ * ## Cleanup on Destroy
+ *
+ * By default, the function cancels any pending batch when the component is destroyed.
+ * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+ *
+ * ```ts
+ * const batcher = injectBatcher(fn, {
+ *   maxSize: 5,
+ *   onUnmount: (b) => b.flush()
+ * });
+ * ```
+ *
  * @example
  * ```ts
  * // Default behavior - no reactive state subscriptions
@@ -52,7 +71,7 @@ interface AngularBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, '
  * const { items, isPending } = batcher.state();
  * ```
  */
-declare function injectBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => void, options?: BatcherOptions<TValue>, selector?: (state: BatcherState<TValue>) => TSelected): AngularBatcher<TValue, TSelected>;
+declare function injectBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => void, options?: AngularBatcherOptions<TValue, TSelected>, selector?: (state: BatcherState<TValue>) => TSelected): AngularBatcher<TValue, TSelected>;
 //#endregion
-export { AngularBatcher, injectBatcher };
+export { AngularBatcher, AngularBatcherOptions, injectBatcher };
 //# sourceMappingURL=injectBatcher.d.cts.map

package/dist/batcher/injectBatcher.d.ts

@@ -1,8 +1,15 @@
 import { Signal } from "@angular/core";
+import { Store } from "@tanstack/angular-store";
 import { Batcher, BatcherOptions, BatcherState } from "@tanstack/pacer/batcher";
-import { Store } from "@tanstack/store";
 
 //#region src/batcher/injectBatcher.d.ts
+interface AngularBatcherOptions<TValue, TSelected = {}> extends BatcherOptions<TValue> {
+  /**
+   * Optional callback invoked when the component is destroyed. Receives the batcher instance.
+   * When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc.
+   */
+  onUnmount?: (batcher: AngularBatcher<TValue, TSelected>) => void;
+}
 interface AngularBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, 'store'> {
   /**
    * Reactive state signal that will be updated when the batcher state changes
@@ -37,6 +44,18 @@ interface AngularBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, '
  * tracking by providing a selector function. This prevents unnecessary updates and gives you
  * full control over when your component tracks state changes.
  *
+ * ## Cleanup on Destroy
+ *
+ * By default, the function cancels any pending batch when the component is destroyed.
+ * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+ *
+ * ```ts
+ * const batcher = injectBatcher(fn, {
+ *   maxSize: 5,
+ *   onUnmount: (b) => b.flush()
+ * });
+ * ```
+ *
  * @example
  * ```ts
  * // Default behavior - no reactive state subscriptions
@@ -52,7 +71,7 @@ interface AngularBatcher<TValue, TSelected = {}> extends Omit<Batcher<TValue>, '
  * const { items, isPending } = batcher.state();
  * ```
  */
-declare function injectBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => void, options?: BatcherOptions<TValue>, selector?: (state: BatcherState<TValue>) => TSelected): AngularBatcher<TValue, TSelected>;
+declare function injectBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => void, options?: AngularBatcherOptions<TValue, TSelected>, selector?: (state: BatcherState<TValue>) => TSelected): AngularBatcher<TValue, TSelected>;
 //#endregion
-export { AngularBatcher, injectBatcher };
+export { AngularBatcher, AngularBatcherOptions, injectBatcher };
 //# sourceMappingURL=injectBatcher.d.ts.map

package/dist/batcher/injectBatcher.js

@@ -1,4 +1,5 @@
 import { injectPacerOptions } from "../provider/pacer-context.js";
+import { DestroyRef, inject } from "@angular/core";
 import { injectStore } from "@tanstack/angular-store";
 import { Batcher } from "@tanstack/pacer/batcher";
 
@@ -24,6 +25,18 @@ import { Batcher } from "@tanstack/pacer/batcher";
 * tracking by providing a selector function. This prevents unnecessary updates and gives you
 * full control over when your component tracks state changes.
 *
+* ## Cleanup on Destroy
+*
+* By default, the function cancels any pending batch when the component is destroyed.
+* Use the `onUnmount` option to customize this. For example, to flush pending work instead:
+*
+* ```ts
+* const batcher = injectBatcher(fn, {
+*   maxSize: 5,
+*   onUnmount: (b) => b.flush()
+* });
+* ```
+*
 * @example
 * ```ts
 * // Default behavior - no reactive state subscriptions
@@ -40,15 +53,21 @@ import { Batcher } from "@tanstack/pacer/batcher";
 * ```
 */
 function injectBatcher(fn, options = {}, selector = () => ({})) {
-	const batcher = new Batcher(fn, {
+	const mergedOptions = {
 		...injectPacerOptions().batcher,
 		...options
-	});
+	};
+	const batcher = new Batcher(fn, mergedOptions);
 	const state = injectStore(batcher.store, selector);
-	return {
+	const result = {
 		...batcher,
 		state
 	};
+	inject(DestroyRef, { optional: true })?.onDestroy(() => {
+		if (mergedOptions.onUnmount) mergedOptions.onUnmount(result);
+		else batcher.cancel();
+	});
+	return result;
 }
 
 //#endregion

package/dist/batcher/injectBatcher.js.map

@@ -1 +1 @@
-{"version":3,"file":"injectBatcher.js","names":[],"sources":["../../src/batcher/injectBatcher.ts"],"sourcesContent":["import { injectStore } from '@tanstack/angular-store'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\n\nexport interface AngularBatcher<TValue, TSelected = {}> extends Omit<\n  Batcher<TValue>,\n  'store'\n> {\n  /**\n   * Reactive state signal that will be updated when the batcher state changes\n   *\n   * Use this instead of `batcher.store.state`\n   */\n  readonly state: Signal<Readonly<TSelected>>\n  /**\n   * @deprecated Use `batcher.state` instead of `batcher.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<BatcherState<TValue>>>\n}\n\n/**\n * An Angular function that creates and manages a Batcher instance.\n *\n * This is a lower-level function that provides direct access to the Batcher's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\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 * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const batcher = injectBatcher(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 }\n * );\n *\n * // Add items\n * batcher.addItem('task1');\n *\n * // Access the selected state\n * const { items, isPending } = batcher.state();\n * ```\n */\nexport function injectBatcher<TValue, TSelected = {}>(\n  fn: (items: Array<TValue>) => void,\n  options: BatcherOptions<TValue> = {},\n  selector: (state: BatcherState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): AngularBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...injectPacerOptions().batcher,\n    ...options,\n  } as BatcherOptions<TValue>\n\n  const batcher = new Batcher<TValue>(fn, mergedOptions)\n  const state = injectStore(batcher.store, selector)\n\n  return {\n    ...batcher,\n    state,\n  } as AngularBatcher<TValue, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4DA,SAAgB,cACd,IACA,UAAkC,EAAE,EACpC,kBACG,EAAE,GAC8B;CAMnC,MAAM,UAAU,IAAI,QAAgB,IALd;EACpB,GAAG,oBAAoB,CAAC;EACxB,GAAG;EACJ,CAEqD;CACtD,MAAM,QAAQ,YAAY,QAAQ,OAAO,SAAS;AAElD,QAAO;EACL,GAAG;EACH;EACD"}
+{"version":3,"file":"injectBatcher.js","names":[],"sources":["../../src/batcher/injectBatcher.ts"],"sourcesContent":["import { DestroyRef, inject } from '@angular/core'\nimport { injectStore } from '@tanstack/angular-store'\nimport { Batcher } from '@tanstack/pacer/batcher'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/angular-store'\nimport type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'\n\nexport interface AngularBatcherOptions<\n  TValue,\n  TSelected = {},\n> extends BatcherOptions<TValue> {\n  /**\n   * Optional callback invoked when the component is destroyed. Receives the batcher instance.\n   * When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc.\n   */\n  onUnmount?: (batcher: AngularBatcher<TValue, TSelected>) => void\n}\n\nexport interface AngularBatcher<TValue, TSelected = {}> extends Omit<\n  Batcher<TValue>,\n  'store'\n> {\n  /**\n   * Reactive state signal that will be updated when the batcher state changes\n   *\n   * Use this instead of `batcher.store.state`\n   */\n  readonly state: Signal<Readonly<TSelected>>\n  /**\n   * @deprecated Use `batcher.state` instead of `batcher.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<BatcherState<TValue>>>\n}\n\n/**\n * An Angular function that creates and manages a Batcher instance.\n *\n * This is a lower-level function that provides direct access to the Batcher's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * The Batcher collects items and processes them in batches based on configurable conditions:\n * - Maximum batch size\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\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 * ## Cleanup on Destroy\n *\n * By default, the function cancels any pending batch 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 batcher = injectBatcher(fn, {\n *   maxSize: 5,\n *   onUnmount: (b) => b.flush()\n * });\n * ```\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const batcher = injectBatcher(\n *   (items) => console.log('Processing batch:', items),\n *   { maxSize: 5, wait: 2000 }\n * );\n *\n * // Add items\n * batcher.addItem('task1');\n *\n * // Access the selected state\n * const { items, isPending } = batcher.state();\n * ```\n */\nexport function injectBatcher<TValue, TSelected = {}>(\n  fn: (items: Array<TValue>) => void,\n  options: AngularBatcherOptions<TValue, TSelected> = {},\n  selector: (state: BatcherState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): AngularBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...injectPacerOptions().batcher,\n    ...options,\n  } as AngularBatcherOptions<TValue, TSelected>\n\n  const batcher = new Batcher<TValue>(fn, mergedOptions)\n  const state = injectStore(batcher.store, selector)\n\n  const result = {\n    ...batcher,\n    state,\n  } as AngularBatcher<TValue, TSelected>\n\n  const destroyRef = inject(DestroyRef, { optional: true })\n  destroyRef?.onDestroy(() => {\n    if (mergedOptions.onUnmount) {\n      mergedOptions.onUnmount(result)\n    } else {\n      batcher.cancel()\n    }\n  })\n\n  return result\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoFA,SAAgB,cACd,IACA,UAAoD,EAAE,EACtD,kBACG,EAAE,GAC8B;CACnC,MAAM,gBAAgB;EACpB,GAAG,oBAAoB,CAAC;EACxB,GAAG;EACJ;CAED,MAAM,UAAU,IAAI,QAAgB,IAAI,cAAc;CACtD,MAAM,QAAQ,YAAY,QAAQ,OAAO,SAAS;CAElD,MAAM,SAAS;EACb,GAAG;EACH;EACD;AAGD,CADmB,OAAO,YAAY,EAAE,UAAU,MAAM,CAAC,EAC7C,gBAAgB;AAC1B,MAAI,cAAc,UAChB,eAAc,UAAU,OAAO;MAE/B,SAAQ,QAAQ;GAElB;AAEF,QAAO"}

package/dist/debouncer/index.d.cts

@@ -1,6 +1,6 @@
 import { injectDebouncedCallback } from "./injectDebouncedCallback.cjs";
-import { AngularDebouncer, injectDebouncer } from "./injectDebouncer.cjs";
+import { AngularDebouncer, AngularDebouncerOptions, injectDebouncer } from "./injectDebouncer.cjs";
 import { DebouncedSignal, injectDebouncedSignal } from "./injectDebouncedSignal.cjs";
 import { injectDebouncedValue } from "./injectDebouncedValue.cjs";
 export * from "@tanstack/pacer/debouncer";
-export { AngularDebouncer, DebouncedSignal, injectDebouncedCallback, injectDebouncedSignal, injectDebouncedValue, injectDebouncer };
+export { AngularDebouncer, AngularDebouncerOptions, DebouncedSignal, injectDebouncedCallback, injectDebouncedSignal, injectDebouncedValue, injectDebouncer };

package/dist/debouncer/index.d.ts

@@ -1,6 +1,6 @@
 import { injectDebouncedCallback } from "./injectDebouncedCallback.js";
-import { AngularDebouncer, injectDebouncer } from "./injectDebouncer.js";
+import { AngularDebouncer, AngularDebouncerOptions, injectDebouncer } from "./injectDebouncer.js";
 import { DebouncedSignal, injectDebouncedSignal } from "./injectDebouncedSignal.js";
 import { injectDebouncedValue } from "./injectDebouncedValue.js";
 export * from "@tanstack/pacer/debouncer";
-export { AngularDebouncer, DebouncedSignal, injectDebouncedCallback, injectDebouncedSignal, injectDebouncedValue, injectDebouncer };
+export { AngularDebouncer, AngularDebouncerOptions, DebouncedSignal, injectDebouncedCallback, injectDebouncedSignal, injectDebouncedValue, injectDebouncer };

package/dist/debouncer/injectDebouncer.cjs

@@ -1,4 +1,5 @@
 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_debouncer = require("@tanstack/pacer/debouncer");
 
@@ -34,6 +35,18 @@ let _tanstack_pacer_debouncer = require("@tanstack/pacer/debouncer");
 * - `lastArgs`: The arguments from the most recent call to maybeExecute
 * - `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 debouncer = injectDebouncer(fn, {
+*   wait: 500,
+*   onUnmount: (d) => d.flush()
+* });
+* ```
+*
 * @example
 * ```ts
 * // Default behavior - no reactive state subscriptions
@@ -60,15 +73,21 @@ let _tanstack_pacer_debouncer = require("@tanstack/pacer/debouncer");
 * ```
 */
 function injectDebouncer(fn, options, selector = () => ({})) {
-	const debouncer = new _tanstack_pacer_debouncer.Debouncer(fn, {
+	const mergedOptions = {
 		...require_pacer_context.injectPacerOptions().debouncer,
 		...options
-	});
+	};
+	const debouncer = new _tanstack_pacer_debouncer.Debouncer(fn, mergedOptions);
 	const state = (0, _tanstack_angular_store.injectStore)(debouncer.store, selector);
-	return {
+	const result = {
 		...debouncer,
 		state
 	};
+	(0, _angular_core.inject)(_angular_core.DestroyRef, { optional: true })?.onDestroy(() => {
+		if (mergedOptions.onUnmount) mergedOptions.onUnmount(result);
+		else debouncer.cancel();
+	});
+	return result;
 }
 
 //#endregion

package/dist/debouncer/injectDebouncer.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"injectDebouncer.cjs","names":["Debouncer","injectPacerOptions"],"sources":["../../src/debouncer/injectDebouncer.ts"],"sourcesContent":["import { injectStore } from '@tanstack/angular-store'\nimport { Debouncer } from '@tanstack/pacer/debouncer'\nimport { injectPacerOptions } from '../provider/pacer-context'\nimport type { Signal } from '@angular/core'\nimport type { Store } from '@tanstack/store'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n  DebouncerOptions,\n  DebouncerState,\n} from '@tanstack/pacer/debouncer'\n\nexport interface AngularDebouncer<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Debouncer<TFn>, 'store'> {\n  /**\n   * Reactive state signal that will be updated when the debouncer state changes\n   *\n   * Use this instead of `debouncer.store.state`\n   */\n  readonly state: Signal<Readonly<TSelected>>\n  /**\n   * @deprecated Use `debouncer.state` instead of `debouncer.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<DebouncerState<TFn>>>\n}\n\n/**\n * An Angular function that creates and manages a Debouncer instance.\n *\n * This is a lower-level function that provides direct access to the Debouncer's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * This function provides debouncing functionality to limit how often a function can be called,\n * waiting for a specified delay before executing the latest call. This is useful for handling\n * frequent events like window resizing, scroll events, or real-time search inputs.\n *\n * The debouncer will only execute the function after the specified wait time has elapsed\n * since the last call. If the function is called again before the wait time expires, the\n * timer resets and starts waiting again.\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 debouncer can execute on the leading edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const debouncer = injectDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 }\n * );\n *\n * // Opt-in to track isPending changes (optimized for loading states)\n * const debouncer = injectDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 },\n *   (state) => ({ isPending: state.isPending })\n * );\n *\n * // In an event handler\n * const handleChange = (e: Event) => {\n *   const target = e.target as HTMLInputElement\n *   debouncer.maybeExecute(target.value);\n * };\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending } = debouncer.state();\n * ```\n */\nexport function injectDebouncer<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: DebouncerOptions<TFn>,\n  selector: (state: DebouncerState<TFn>) => TSelected = () => ({}) as TSelected,\n): AngularDebouncer<TFn, TSelected> {\n  const mergedOptions = {\n    ...injectPacerOptions().debouncer,\n    ...options,\n  } as DebouncerOptions<TFn>\n\n  const debouncer = new Debouncer<TFn>(fn, mergedOptions)\n  const state = injectStore(debouncer.store, selector)\n\n  return {\n    ...debouncer,\n    state,\n  } as AngularDebouncer<TFn, TSelected>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoFA,SAAgB,gBACd,IACA,SACA,kBAA6D,EAAE,GAC7B;CAMlC,MAAM,YAAY,IAAIA,oCAAe,IALf;EACpB,GAAGC,0CAAoB,CAAC;EACxB,GAAG;EACJ,CAEsD;CACvD,MAAM,iDAAoB,UAAU,OAAO,SAAS;AAEpD,QAAO;EACL,GAAG;EACH;EACD"}
+{"version":3,"file":"injectDebouncer.cjs","names":["injectPacerOptions","Debouncer","DestroyRef"],"sources":["../../src/debouncer/injectDebouncer.ts"],"sourcesContent":["import { DestroyRef, inject } from '@angular/core'\nimport { injectStore } from '@tanstack/angular-store'\nimport { Debouncer } from '@tanstack/pacer/debouncer'\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  DebouncerOptions,\n  DebouncerState,\n} from '@tanstack/pacer/debouncer'\n\nexport interface AngularDebouncerOptions<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends DebouncerOptions<TFn> {\n  /**\n   * Optional callback invoked when the component is destroyed. Receives the debouncer instance.\n   * When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc.\n   */\n  onUnmount?: (debouncer: AngularDebouncer<TFn, TSelected>) => void\n}\n\nexport interface AngularDebouncer<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Debouncer<TFn>, 'store'> {\n  /**\n   * Reactive state signal that will be updated when the debouncer state changes\n   *\n   * Use this instead of `debouncer.store.state`\n   */\n  readonly state: Signal<Readonly<TSelected>>\n  /**\n   * @deprecated Use `debouncer.state` instead of `debouncer.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<DebouncerState<TFn>>>\n}\n\n/**\n * An Angular function that creates and manages a Debouncer instance.\n *\n * This is a lower-level function that provides direct access to the Debouncer's functionality.\n * This allows you to integrate it with any state management solution you prefer.\n *\n * This function provides debouncing functionality to limit how often a function can be called,\n * waiting for a specified delay before executing the latest call. This is useful for handling\n * frequent events like window resizing, scroll events, or real-time search inputs.\n *\n * The debouncer will only execute the function after the specified wait time has elapsed\n * since the last call. If the function is called again before the wait time expires, the\n * timer resets and starts waiting again.\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 debouncer can execute on the leading edge\n * - `executionCount`: Number of function executions that have been completed\n * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\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 debouncer = injectDebouncer(fn, {\n *   wait: 500,\n *   onUnmount: (d) => d.flush()\n * });\n * ```\n *\n * @example\n * ```ts\n * // Default behavior - no reactive state subscriptions\n * const debouncer = injectDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 }\n * );\n *\n * // Opt-in to track isPending changes (optimized for loading states)\n * const debouncer = injectDebouncer(\n *   (query: string) => fetchSearchResults(query),\n *   { wait: 500 },\n *   (state) => ({ isPending: state.isPending })\n * );\n *\n * // In an event handler\n * const handleChange = (e: Event) => {\n *   const target = e.target as HTMLInputElement\n *   debouncer.maybeExecute(target.value);\n * };\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isPending } = debouncer.state();\n * ```\n */\nexport function injectDebouncer<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: AngularDebouncerOptions<TFn, TSelected>,\n  selector: (state: DebouncerState<TFn>) => TSelected = () => ({}) as TSelected,\n): AngularDebouncer<TFn, TSelected> {\n  const mergedOptions = {\n    ...injectPacerOptions().debouncer,\n    ...options,\n  } as AngularDebouncerOptions<TFn, TSelected>\n\n  const debouncer = new Debouncer<TFn>(fn, mergedOptions)\n  const state = injectStore(debouncer.store, selector)\n\n  const result = {\n    ...debouncer,\n    state,\n  } as AngularDebouncer<TFn, TSelected>\n\n  const destroyRef = inject(DestroyRef, { optional: true })\n  destroyRef?.onDestroy(() => {\n    if (mergedOptions.onUnmount) {\n      mergedOptions.onUnmount(result)\n    } else {\n      debouncer.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,iDAAoB,UAAU,OAAO,SAAS;CAEpD,MAAM,SAAS;EACb,GAAG;EACH;EACD;AAGD,2BAD0BC,0BAAY,EAAE,UAAU,MAAM,CAAC,EAC7C,gBAAgB;AAC1B,MAAI,cAAc,UAChB,eAAc,UAAU,OAAO;MAE/B,WAAU,QAAQ;GAEpB;AAEF,QAAO"}

package/dist/debouncer/injectDebouncer.d.cts

@@ -1,9 +1,16 @@
 import { Signal } from "@angular/core";
-import { Store } from "@tanstack/store";
+import { Store } from "@tanstack/angular-store";
 import { AnyFunction } from "@tanstack/pacer/types";
 import { Debouncer, DebouncerOptions, DebouncerState } from "@tanstack/pacer/debouncer";
 
 //#region src/debouncer/injectDebouncer.d.ts
+interface AngularDebouncerOptions<TFn extends AnyFunction, TSelected = {}> extends DebouncerOptions<TFn> {
+  /**
+   * Optional callback invoked when the component is destroyed. Receives the debouncer instance.
+   * When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc.
+   */
+  onUnmount?: (debouncer: AngularDebouncer<TFn, TSelected>) => void;
+}
 interface AngularDebouncer<TFn extends AnyFunction, TSelected = {}> extends Omit<Debouncer<TFn>, 'store'> {
   /**
    * Reactive state signal that will be updated when the debouncer state changes
@@ -48,6 +55,18 @@ interface AngularDebouncer<TFn extends AnyFunction, TSelected = {}> extends Omit
  * - `lastArgs`: The arguments from the most recent call to maybeExecute
  * - `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 debouncer = injectDebouncer(fn, {
+ *   wait: 500,
+ *   onUnmount: (d) => d.flush()
+ * });
+ * ```
+ *
  * @example
  * ```ts
  * // Default behavior - no reactive state subscriptions
@@ -73,7 +92,7 @@ interface AngularDebouncer<TFn extends AnyFunction, TSelected = {}> extends Omit
  * const { isPending } = debouncer.state();
  * ```
  */
-declare function injectDebouncer<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: DebouncerOptions<TFn>, selector?: (state: DebouncerState<TFn>) => TSelected): AngularDebouncer<TFn, TSelected>;
+declare function injectDebouncer<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: AngularDebouncerOptions<TFn, TSelected>, selector?: (state: DebouncerState<TFn>) => TSelected): AngularDebouncer<TFn, TSelected>;
 //#endregion
-export { AngularDebouncer, injectDebouncer };
+export { AngularDebouncer, AngularDebouncerOptions, injectDebouncer };
 //# sourceMappingURL=injectDebouncer.d.cts.map

package/dist/debouncer/injectDebouncer.d.ts

@@ -1,9 +1,16 @@
 import { Signal } from "@angular/core";
+import { Store } from "@tanstack/angular-store";
 import { Debouncer, DebouncerOptions, DebouncerState } from "@tanstack/pacer/debouncer";
 import { AnyFunction } from "@tanstack/pacer/types";
-import { Store } from "@tanstack/store";
 
 //#region src/debouncer/injectDebouncer.d.ts
+interface AngularDebouncerOptions<TFn extends AnyFunction, TSelected = {}> extends DebouncerOptions<TFn> {
+  /**
+   * Optional callback invoked when the component is destroyed. Receives the debouncer instance.
+   * When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc.
+   */
+  onUnmount?: (debouncer: AngularDebouncer<TFn, TSelected>) => void;
+}
 interface AngularDebouncer<TFn extends AnyFunction, TSelected = {}> extends Omit<Debouncer<TFn>, 'store'> {
   /**
    * Reactive state signal that will be updated when the debouncer state changes
@@ -48,6 +55,18 @@ interface AngularDebouncer<TFn extends AnyFunction, TSelected = {}> extends Omit
  * - `lastArgs`: The arguments from the most recent call to maybeExecute
  * - `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 debouncer = injectDebouncer(fn, {
+ *   wait: 500,
+ *   onUnmount: (d) => d.flush()
+ * });
+ * ```
+ *
  * @example
  * ```ts
  * // Default behavior - no reactive state subscriptions
@@ -73,7 +92,7 @@ interface AngularDebouncer<TFn extends AnyFunction, TSelected = {}> extends Omit
  * const { isPending } = debouncer.state();
  * ```
  */
-declare function injectDebouncer<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: DebouncerOptions<TFn>, selector?: (state: DebouncerState<TFn>) => TSelected): AngularDebouncer<TFn, TSelected>;
+declare function injectDebouncer<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: AngularDebouncerOptions<TFn, TSelected>, selector?: (state: DebouncerState<TFn>) => TSelected): AngularDebouncer<TFn, TSelected>;
 //#endregion
-export { AngularDebouncer, injectDebouncer };
+export { AngularDebouncer, AngularDebouncerOptions, injectDebouncer };
 //# sourceMappingURL=injectDebouncer.d.ts.map