@tanstack/pacer-lite 0.2.1 → 0.3.0

package/README.md

@@ -1,5 +1,19 @@
 <div align="center">
-  <img src="./media/header_pacer.png" >
+  <picture>
+    <source
+      media="(prefers-color-scheme: dark)"
+      srcset="https://tanstack.com/api/readme/pacer.png?theme=dark"
+    />
+    <source
+      media="(prefers-color-scheme: light)"
+      srcset="https://tanstack.com/api/readme/pacer.png"
+    />
+    <img
+      src="https://tanstack.com/api/readme/pacer.png"
+      alt="TanStack Pacer"
+      width="900"
+    />
+  </picture>
 </div>
 
 <br />
@@ -29,8 +43,9 @@
 </div>
 
 <div align="center">
-  
+
 ### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
+
 </div>
 
 # TanStack Pacer
@@ -86,12 +101,12 @@ A lightweight timing and scheduling library for debouncing, throttling, rate lim
 <br />
 
 > [!NOTE]
-> You may know **TanSack Pacer** by our adapter names, too!
+> You may know **TanStack Pacer** by our adapter names, too!
 >
-> - [**React Pacer**](https://tanstack.com/pacer/latest/docs/framework/react/react-pacer)
-> - [**Preact Pacer**](https://tanstack.com/pacer/latest/docs/framework/preact/preact-pacer)
-> - [**Solid Pacer**](https://tanstack.com/pacer/latest/docs/framework/solid/solid-pacer)
-> - Angular Pacer - needs a contributor!
+> - [**React Pacer**](https://tanstack.com/pacer/latest/docs/framework/react)
+> - [**Preact Pacer**](https://tanstack.com/pacer/latest/docs/framework/preact)
+> - [**Solid Pacer**](https://tanstack.com/pacer/latest/docs/framework/solid)
+> - [**Angular Pacer**](https://tanstack.com/pacer/latest/docs/framework/angular)
 > - Svelte Pacer - needs a contributor!
 > - Vue Pacer - needs a contributor!
 
@@ -106,21 +121,21 @@ A lightweight timing and scheduling library for debouncing, throttling, rate lim
 
 <table align="center">
   <tr>
-    <td>
+        <td>
       <a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS" >
         <picture>
-          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-CMcuvjEy.svg" height="40" />
-          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" />
-          <img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" />
+          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-D643Zkrv.svg" />
+          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-CIzGLYU_.svg" />
+          <img src="https://tanstack.com/assets/coderabbit-light-CIzGLYU_.svg" height="40" alt="CodeRabbit" />
         </picture>
       </a>
     </td>
     <td>
       <a href="https://www.cloudflare.com?utm_source=tanstack">
         <picture>
-          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-DQDB7UaL.svg" height="60" />
-          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" />
-          <img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" />
+          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-Co-Tyjbl.svg" />
+          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-6Ojsn8yh.svg" />
+          <img src="https://tanstack.com/assets/cloudflare-white-Co-Tyjbl.svg" height="60" alt="Cloudflare" />
         </picture>
       </a>
     </td>

package/dist/lite-batcher.d.ts

@@ -2,7 +2,7 @@
 /**
  * Options for configuring a lite batcher instance
  */
-interface LiteBatcherOptions<TValue> {
+export interface LiteBatcherOptions<TValue> {
   /**
    * Custom function to determine if a batch should be processed
    * Return true to process the batch immediately
@@ -103,7 +103,7 @@ interface LiteBatcherOptions<TValue> {
  * batcher.addItem({ name: 'urgent', urgent: true }); // Triggers immediate processing
  * ```
  */
-declare class LiteBatcher<TValue> {
+export declare class LiteBatcher<TValue> {
   fn: (items: Array<TValue>) => void;
   options: LiteBatcherOptions<TValue>;
   private items;
@@ -178,7 +178,5 @@ declare class LiteBatcher<TValue> {
  * batchItems(3); // Triggers batch processing
  * ```
  */
-declare function liteBatch<TValue>(fn: (items: Array<TValue>) => void, options?: LiteBatcherOptions<TValue>): (item: TValue) => void;
-//#endregion
-export { LiteBatcher, LiteBatcherOptions, liteBatch };
-//# sourceMappingURL=lite-batcher.d.ts.map
+export declare function liteBatch<TValue>(fn: (items: Array<TValue>) => void, options?: LiteBatcherOptions<TValue>): (item: TValue) => void;
+//#endregion

package/dist/lite-batcher.js

@@ -69,52 +69,14 @@
 * ```
 */
 var LiteBatcher = class {
+	fn;
+	options;
+	items = [];
+	timeoutId = null;
+	_isPending = false;
 	constructor(fn, options = {}) {
 		this.fn = fn;
 		this.options = options;
-		this.items = [];
-		this.timeoutId = null;
-		this._isPending = false;
-		this.addItem = (item) => {
-			this.items.push(item);
-			this._isPending = this.options.wait !== Infinity;
-			this.options.onItemsChange?.(this);
-			if (this.items.length >= this.options.maxSize || this.options.getShouldExecute(this.items, this)) this.execute();
-			else if (this.options.wait !== Infinity) {
-				this.clearTimeout();
-				this.timeoutId = setTimeout(() => this.execute(), this.getWait());
-			}
-		};
-		this.execute = () => {
-			if (this.items.length === 0) return;
-			const batch = this.peekAllItems();
-			this.clear();
-			this.fn(batch);
-			this.options.onExecute?.(batch, this);
-		};
-		this.flush = () => {
-			this.clearTimeout();
-			this.execute();
-		};
-		this.peekAllItems = () => {
-			return [...this.items];
-		};
-		this.clearTimeout = () => {
-			if (this.timeoutId) {
-				clearTimeout(this.timeoutId);
-				this.timeoutId = null;
-			}
-		};
-		this.clear = () => {
-			const hadItems = this.items.length > 0;
-			this.items = [];
-			this._isPending = false;
-			if (hadItems) this.options.onItemsChange?.(this);
-		};
-		this.cancel = () => {
-			this.clearTimeout();
-			this._isPending = false;
-		};
 		this.options.maxSize = this.options.maxSize ?? Infinity;
 		this.options.started = this.options.started ?? true;
 		this.options.wait = this.options.wait ?? Infinity;
@@ -142,6 +104,72 @@ var LiteBatcher = class {
 		if (typeof this.options.wait === "function") return this.options.wait(this);
 		return this.options.wait;
 	}
+	/**
+	* Adds an item to the batcher
+	* If the batch size is reached, timeout occurs, or getShouldExecute returns true, the batch will be processed
+	*/
+	addItem = (item) => {
+		this.items.push(item);
+		this._isPending = this.options.wait !== Infinity;
+		this.options.onItemsChange?.(this);
+		if (this.items.length >= this.options.maxSize || this.options.getShouldExecute(this.items, this)) this.execute();
+		else if (this.options.wait !== Infinity) {
+			this.clearTimeout();
+			this.timeoutId = setTimeout(() => this.execute(), this.getWait());
+		}
+	};
+	/**
+	* Processes the current batch of items.
+	* This method will automatically be triggered if the batcher is running and any of these conditions are met:
+	* - The number of items reaches maxSize
+	* - The wait duration has elapsed
+	* - The getShouldExecute function returns true upon adding an item
+	*
+	* You can also call this method manually to process the current batch at any time.
+	*/
+	execute = () => {
+		if (this.items.length === 0) return;
+		const batch = this.peekAllItems();
+		this.clear();
+		this.fn(batch);
+		this.options.onExecute?.(batch, this);
+	};
+	/**
+	* Processes the current batch of items immediately
+	*/
+	flush = () => {
+		this.clearTimeout();
+		this.execute();
+	};
+	/**
+	* Returns a copy of all items in the batcher
+	*/
+	peekAllItems = () => {
+		return [...this.items];
+	};
+	clearTimeout = () => {
+		if (this.timeoutId) {
+			clearTimeout(this.timeoutId);
+			this.timeoutId = null;
+		}
+	};
+	/**
+	* Removes all items from the batcher
+	*/
+	clear = () => {
+		const hadItems = this.items.length > 0;
+		this.items = [];
+		this._isPending = false;
+		if (hadItems) this.options.onItemsChange?.(this);
+	};
+	/**
+	* Cancels any pending execution that was scheduled.
+	* Does NOT clear out the items.
+	*/
+	cancel = () => {
+		this.clearTimeout();
+		this._isPending = false;
+	};
 };
 /**
 * Creates a batcher that processes items in batches.
@@ -169,5 +197,4 @@ function liteBatch(fn, options = {}) {
 }
 
 //#endregion
-export { LiteBatcher, liteBatch };
-//# sourceMappingURL=lite-batcher.js.map
+export { LiteBatcher, liteBatch };

package/dist/lite-debouncer.d.ts

@@ -1,11 +1,9 @@
-import { AnyFunction } from "@tanstack/pacer/types";
-
+import { AnyFunction } from "./pacer/dist/types.js";
 //#region src/lite-debouncer.d.ts
-
 /**
  * Options for configuring a lite debounced function
  */
-interface LiteDebouncerOptions<TFn extends AnyFunction = AnyFunction> {
+export interface LiteDebouncerOptions<TFn extends AnyFunction = AnyFunction> {
   /**
    * Whether to execute on the leading edge of the timeout.
    * The first call will execute immediately and the rest will wait the delay.
@@ -66,7 +64,7 @@ interface LiteDebouncerOptions<TFn extends AnyFunction = AnyFunction> {
  * });
  * ```
  */
-declare class LiteDebouncer<TFn extends AnyFunction> {
+export declare class LiteDebouncer<TFn extends AnyFunction> {
   fn: TFn;
   options: LiteDebouncerOptions<TFn>;
   private timeoutId;
@@ -121,7 +119,5 @@ declare class LiteDebouncer<TFn extends AnyFunction> {
  * }, { wait: 300, leading: true });
  * ```
  */
-declare function liteDebounce<TFn extends AnyFunction>(fn: TFn, options: LiteDebouncerOptions<TFn>): (...args: Parameters<TFn>) => void;
-//#endregion
-export { LiteDebouncer, LiteDebouncerOptions, liteDebounce };
-//# sourceMappingURL=lite-debouncer.d.ts.map
+export declare function liteDebounce<TFn extends AnyFunction>(fn: TFn, options: LiteDebouncerOptions<TFn>): (...args: Parameters<TFn>) => void;
+//#endregion

package/dist/lite-debouncer.js

@@ -40,50 +40,69 @@
 * ```
 */
 var LiteDebouncer = class {
+	fn;
+	options;
+	timeoutId;
+	lastArgs;
+	canLeadingExecute = true;
 	constructor(fn, options) {
 		this.fn = fn;
 		this.options = options;
-		this.canLeadingExecute = true;
-		this.maybeExecute = (...args) => {
-			let didLeadingExecute = false;
-			if (this.options.leading && this.canLeadingExecute) {
-				this.canLeadingExecute = false;
-				didLeadingExecute = true;
-				this.fn(...args);
-				this.options.onExecute?.(args, this);
-			}
-			this.lastArgs = args;
-			if (this.timeoutId) clearTimeout(this.timeoutId);
-			this.timeoutId = setTimeout(() => {
-				this.canLeadingExecute = true;
-				if (this.options.trailing && !didLeadingExecute && this.lastArgs) {
-					this.fn(...this.lastArgs);
-					this.options.onExecute?.(this.lastArgs, this);
-				}
-				this.lastArgs = void 0;
-			}, this.options.wait);
-		};
-		this.flush = () => {
-			if (this.timeoutId && this.lastArgs) {
-				clearTimeout(this.timeoutId);
-				this.timeoutId = void 0;
-				const args = this.lastArgs;
-				this.fn(...args);
-				this.options.onExecute?.(args, this);
-				this.lastArgs = void 0;
-				this.canLeadingExecute = true;
-			}
-		};
-		this.cancel = () => {
-			if (this.timeoutId) {
-				clearTimeout(this.timeoutId);
-				this.timeoutId = void 0;
+		if (this.options.leading === void 0 && this.options.trailing === void 0) this.options.trailing = true;
+	}
+	/**
+	* Attempts to execute the debounced function.
+	* If leading is true and this is the first call, executes immediately.
+	* Otherwise, queues the execution for after the wait time.
+	* Each new call resets the timer.
+	*/
+	maybeExecute = (...args) => {
+		let didLeadingExecute = false;
+		if (this.options.leading && this.canLeadingExecute) {
+			this.canLeadingExecute = false;
+			didLeadingExecute = true;
+			this.fn(...args);
+			this.options.onExecute?.(args, this);
+		}
+		this.lastArgs = args;
+		if (this.timeoutId) clearTimeout(this.timeoutId);
+		this.timeoutId = setTimeout(() => {
+			this.canLeadingExecute = true;
+			if (this.options.trailing && !didLeadingExecute && this.lastArgs) {
+				this.fn(...this.lastArgs);
+				this.options.onExecute?.(this.lastArgs, this);
 			}
 			this.lastArgs = void 0;
+		}, this.options.wait);
+	};
+	/**
+	* Processes the current pending execution immediately.
+	* If there's a pending execution, it will be executed right away
+	* and the timeout will be cleared.
+	*/
+	flush = () => {
+		if (this.timeoutId && this.lastArgs) {
+			clearTimeout(this.timeoutId);
+			this.timeoutId = void 0;
+			const args = this.lastArgs;
+			this.fn(...args);
+			this.options.onExecute?.(args, this);
+			this.lastArgs = void 0;
 			this.canLeadingExecute = true;
-		};
-		if (this.options.leading === void 0 && this.options.trailing === void 0) this.options.trailing = true;
-	}
+		}
+	};
+	/**
+	* Cancels any pending execution.
+	* Clears the timeout and resets the internal state.
+	*/
+	cancel = () => {
+		if (this.timeoutId) {
+			clearTimeout(this.timeoutId);
+			this.timeoutId = void 0;
+		}
+		this.lastArgs = void 0;
+		this.canLeadingExecute = true;
+	};
 };
 /**
 * Creates a lightweight debounced function that delays invoking the provided function until after a specified wait time.
@@ -119,5 +138,4 @@ function liteDebounce(fn, options) {
 }
 
 //#endregion
-export { LiteDebouncer, liteDebounce };
-//# sourceMappingURL=lite-debouncer.js.map
+export { LiteDebouncer, liteDebounce };

package/dist/lite-queuer.d.ts

@@ -5,11 +5,11 @@
  * - 'front': Operate on the front of the queue (FIFO for getNextItem)
  * - 'back': Operate on the back of the queue (LIFO for getNextItem)
  */
-type QueuePosition = 'front' | 'back';
+export type QueuePosition = 'front' | 'back';
 /**
  * Options for configuring a lite queuer instance
  */
-interface LiteQueuerOptions<TValue> {
+export interface LiteQueuerOptions<TValue> {
   /**
    * Default position to add items to the queue
    * @default 'back'
@@ -105,7 +105,7 @@ interface LiteQueuerOptions<TValue> {
  * // Processes high priority task first
  * ```
  */
-declare class LiteQueuer<TValue> {
+export declare class LiteQueuer<TValue> {
   fn: (item: TValue) => void;
   options: LiteQueuerOptions<TValue>;
   private items;
@@ -237,7 +237,5 @@ declare class LiteQueuer<TValue> {
  * // Processes each item with 1 second delay between them
  * ```
  */
-declare function liteQueue<TValue>(fn: (item: TValue) => void, options?: LiteQueuerOptions<TValue>): (item: TValue) => boolean;
-//#endregion
-export { LiteQueuer, LiteQueuerOptions, QueuePosition, liteQueue };
-//# sourceMappingURL=lite-queuer.d.ts.map
+export declare function liteQueue<TValue>(fn: (item: TValue) => void, options?: LiteQueuerOptions<TValue>): (item: TValue) => boolean;
+//#endregion