@tanstack/pacer 0.16.3 → 0.16.4

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

@@ -1,315 +0,0 @@
-import { Store } from '@tanstack/store';
-import { AsyncRetryer, AsyncRetryerOptions } from './async-retryer.cjs';
-import { AnyAsyncFunction } from './types.cjs';
-export interface AsyncThrottlerState<TFn extends AnyAsyncFunction> {
-    /**
-     * Number of function executions that have resulted in errors
-     */
-    errorCount: number;
-    /**
-     * Whether the throttled function is currently executing asynchronously
-     */
-    isExecuting: boolean;
-    /**
-     * Whether the throttler is waiting for the timeout to trigger execution
-     */
-    isPending: boolean;
-    /**
-     * The arguments from the most recent call to maybeExecute
-     */
-    lastArgs: Parameters<TFn> | undefined;
-    /**
-     * Timestamp of the last function execution in milliseconds
-     */
-    lastExecutionTime: number;
-    /**
-     * The result from the most recent successful function execution
-     */
-    lastResult: ReturnType<TFn> | undefined;
-    /**
-     * Number of times maybeExecute has been called (for reduction calculations)
-     */
-    maybeExecuteCount: number;
-    /**
-     * Timestamp when the next execution can occur in milliseconds
-     */
-    nextExecutionTime: number | undefined;
-    /**
-     * Number of function executions that have completed (either successfully or with errors)
-     */
-    settleCount: number;
-    /**
-     * Current execution status - 'idle' when not active, 'pending' when waiting, 'executing' when running, 'settled' when completed
-     */
-    status: 'disabled' | 'idle' | 'pending' | 'executing' | 'settled';
-    /**
-     * Number of function executions that have completed successfully
-     */
-    successCount: number;
-}
-/**
- * Options for configuring an async throttled function
- */
-export interface AsyncThrottlerOptions<TFn extends AnyAsyncFunction> {
-    /**
-     * Options for configuring the underlying async retryer
-     */
-    asyncRetryerOptions?: AsyncRetryerOptions<TFn>;
-    /**
-     * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.
-     * Can be a boolean or a function that returns a boolean.
-     * Defaults to true.
-     */
-    enabled?: boolean | ((throttler: AsyncThrottler<TFn>) => boolean);
-    /**
-     * Initial state for the async throttler
-     */
-    initialState?: Partial<AsyncThrottlerState<TFn>>;
-    /**
-     * Optional key to identify this async throttler instance.
-     * If provided, the async throttler will be identified by this key in the devtools and PacerProvider if applicable.
-     */
-    key?: string;
-    /**
-     * Whether to execute the function immediately when called
-     * Defaults to true
-     */
-    leading?: boolean;
-    /**
-     * Optional error handler for when the throttled function throws.
-     * If provided, the handler will be called with the error and throttler instance.
-     * This can be used alongside throwOnError - the handler will be called before any error is thrown.
-     */
-    onError?: (error: Error, args: Parameters<TFn>, asyncThrottler: AsyncThrottler<TFn>) => void;
-    /**
-     * Optional function to call when the throttled function is executed
-     */
-    onSettled?: (args: Parameters<TFn>, asyncThrottler: AsyncThrottler<TFn>) => void;
-    /**
-     * Optional function to call when the throttled function is executed
-     */
-    onSuccess?: (result: ReturnType<TFn>, args: Parameters<TFn>, asyncThrottler: AsyncThrottler<TFn>) => void;
-    /**
-     * Whether to throw errors when they occur.
-     * Defaults to true if no onError handler is provided, false if an onError handler is provided.
-     * Can be explicitly set to override these defaults.
-     */
-    throwOnError?: boolean;
-    /**
-     * Whether to execute the function on the trailing edge of the wait period
-     * Defaults to true
-     */
-    trailing?: boolean;
-    /**
-     * Time window in milliseconds during which the function can only be executed once.
-     * Can be a number or a function that returns a number.
-     * Defaults to 0ms
-     */
-    wait: number | ((throttler: AsyncThrottler<TFn>) => number);
-}
-/**
- * Utility function for sharing common `AsyncThrottlerOptions` options between different `AsyncThrottler` instances.
- */
-export declare function asyncThrottlerOptions<TFn extends AnyAsyncFunction = AnyAsyncFunction, TOptions extends Partial<AsyncThrottlerOptions<TFn>> = Partial<AsyncThrottlerOptions<TFn>>>(options: TOptions): TOptions;
-/**
- * A class that creates an async throttled function.
- *
- * Async vs Sync Versions:
- * The async version provides advanced features over the sync Throttler:
- * - Returns promises that can be awaited for throttled function results
- * - Built-in retry support via AsyncRetryer integration
- * - Abort support to cancel in-flight executions
- * - Cancel support to prevent pending executions from starting
- * - Comprehensive error handling with onError callbacks and throwOnError control
- * - Detailed execution tracking (success/error/settle counts)
- * - Waits for ongoing executions to complete before scheduling the next one
- *
- * The sync Throttler is lighter weight and simpler when you don't need async features,
- * return values, or execution control.
- *
- * What is Throttling?
- * Throttling limits how often a function can be executed, allowing only one execution within a specified time window.
- * Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a
- * regular interval regardless of how often it's called.
- *
- * This is useful for rate-limiting API calls, handling scroll/resize events, or any scenario where you want to
- * ensure a maximum execution frequency.
- *
- * Error Handling:
- * - If an `onError` handler is provided, it will be called with the error and throttler instance
- * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
- * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
- * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
- * - The error state can be checked using the underlying AsyncThrottler instance
- *
- * State Management:
- * - Uses TanStack Store for reactive state management
- * - Use `initialState` to provide initial state values when creating the async throttler
- * - Use `onSuccess` callback to react to successful function execution and implement custom logic
- * - Use `onError` callback to react to function execution errors and implement custom error handling
- * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic
- * - The state includes error count, execution status, last execution time, and success/settle counts
- * - State can be accessed via `asyncThrottler.store.state` when using the class directly
- * - When using framework adapters (React/Solid), state is accessed from `asyncThrottler.state`
- *
- * @example
- * ```ts
- * const throttler = new AsyncThrottler(async (value: string) => {
- *   const result = await saveToAPI(value);
- *   return result; // Return value is preserved
- * }, {
- *   wait: 1000,
- *   onError: (error) => {
- *     console.error('API call failed:', error);
- *   }
- * });
- *
- * // Will only execute once per second no matter how often called
- * // Returns the API response directly
- * const result = await throttler.maybeExecute(inputElement.value);
- * ```
- */
-export declare class AsyncThrottler<TFn extends AnyAsyncFunction> {
-    #private;
-    fn: TFn;
-    readonly store: Store<Readonly<AsyncThrottlerState<TFn>>>;
-    key: string | undefined;
-    options: AsyncThrottlerOptions<TFn>;
-    asyncRetryers: Map<number, AsyncRetryer<TFn>>;
-    constructor(fn: TFn, initialOptions: AsyncThrottlerOptions<TFn>);
-    /**
-     * Updates the async throttler options
-     */
-    setOptions: (newOptions: Partial<AsyncThrottlerOptions<TFn>>) => void;
-    /**
-     * Attempts to execute the throttled function. The execution behavior depends on the throttler options:
-     *
-     * - If enough time has passed since the last execution (>= wait period):
-     *   - With leading=true: Executes immediately
-     *   - With leading=false: Waits for the next trailing execution
-     *
-     * - If within the wait period:
-     *   - With trailing=true: Schedules execution for end of wait period
-     *   - With trailing=false: Drops the execution
-     *
-     * @example
-     * ```ts
-     * const throttled = new AsyncThrottler(fn, { wait: 1000 });
-     *
-     * // First call executes immediately
-     * await throttled.maybeExecute('a', 'b');
-     *
-     * // Call during wait period - gets throttled
-     * await throttled.maybeExecute('c', 'd');
-     * ```
-     */
-    maybeExecute: (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;
-    /**
-     * Processes the current pending execution immediately
-     */
-    flush: () => Promise<ReturnType<TFn> | undefined>;
-    /**
-     * Returns the AbortSignal for a specific execution.
-     * If no maybeExecuteCount is provided, returns the signal for the most recent execution.
-     * Returns null if no execution is found or not currently executing.
-     *
-     * @param maybeExecuteCount - Optional specific execution to get signal for
-     * @example
-     * ```typescript
-     * const throttler = new AsyncThrottler(
-     *   async (data: string) => {
-     *     const signal = throttler.getAbortSignal()
-     *     if (signal) {
-     *       const response = await fetch('/api/save', {
-     *         method: 'POST',
-     *         body: data,
-     *         signal
-     *       })
-     *       return response.json()
-     *     }
-     *   },
-     *   { wait: 1000 }
-     * )
-     * ```
-     */
-    getAbortSignal(maybeExecuteCount?: number): AbortSignal | null;
-    /**
-     * Aborts all ongoing executions with the internal abort controllers.
-     * Does NOT cancel any pending execution that have not started yet.
-     */
-    abort: () => void;
-    /**
-     * Cancels any pending execution that have not started yet.
-     * Does NOT abort any execution already in progress.
-     */
-    cancel: () => void;
-    /**
-     * Resets the debouncer state to its default values
-     */
-    reset: () => void;
-}
-/**
- * Creates an async throttled function that limits how often the function can execute.
- * The throttled function will execute at most once per wait period, even if called multiple times.
- * If called while executing, it will wait until execution completes before scheduling the next call.
- *
- * Async vs Sync Versions:
- * The async version provides advanced features over the sync throttle function:
- * - Returns promises that can be awaited for throttled function results
- * - Built-in retry support via AsyncRetryer integration
- * - Abort support to cancel in-flight executions
- * - Cancel support to prevent pending executions from starting
- * - Comprehensive error handling with onError callbacks and throwOnError control
- * - Detailed execution tracking (success/error/settle counts)
- * - Waits for ongoing executions to complete before scheduling the next one
- *
- * The sync throttle function is lighter weight and simpler when you don't need async features,
- * return values, or execution control.
- *
- * What is Throttling?
- * Throttling limits how often a function can be executed, allowing only one execution within a specified time window.
- * Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a
- * regular interval regardless of how often it's called.
- *
- * Configuration Options:
- * - `wait`: Time window in milliseconds during which the function can only execute once (required)
- * - `leading`: Execute immediately when called (default: true)
- * - `trailing`: Execute on the trailing edge of the wait period (default: true)
- * - `enabled`: Whether the throttler is enabled (default: true)
- * - `asyncRetryerOptions`: Configure retry behavior for executions
- *
- * Error Handling:
- * - If an `onError` handler is provided, it will be called with the error and throttler instance
- * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
- * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
- * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
- * - The error state can be checked using the underlying AsyncThrottler instance
- *
- * State Management:
- * - Uses TanStack Store for reactive state management
- * - Use `initialState` to provide initial state values when creating the async throttler
- * - Use `onSuccess` callback to react to successful function execution and implement custom logic
- * - Use `onError` callback to react to function execution errors and implement custom error handling
- * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic
- * - The state includes error count, execution status, last execution time, and success/settle counts
- * - State can be accessed via the underlying AsyncThrottler instance's `store.state` property
- * - When using framework adapters (React/Solid), state is accessed from the hook's state property
- *
- * @example
- * ```ts
- * const throttled = asyncThrottle(async (value: string) => {
- *   const result = await saveToAPI(value);
- *   return result; // Return value is preserved
- * }, {
- *   wait: 1000,
- *   onError: (error) => {
- *     console.error('API call failed:', error);
- *   }
- * });
- *
- * // This will execute at most once per second
- * // Returns the API response directly
- * const result = await throttled(inputElement.value);
- * ```
- */
-export declare function asyncThrottle<TFn extends AnyAsyncFunction>(fn: TFn, initialOptions: AsyncThrottlerOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;

package/dist/cjs/batcher.cjs

@@ -1,132 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const store = require("@tanstack/store");
-const utils = require("./utils.cjs");
-const eventClient = require("./event-client.cjs");
-function getDefaultBatcherState() {
-  return {
-    executionCount: 0,
-    isEmpty: true,
-    isPending: false,
-    totalItemsProcessed: 0,
-    items: [],
-    size: 0,
-    status: "idle"
-  };
-}
-const defaultOptions = {
-  getShouldExecute: () => false,
-  maxSize: Infinity,
-  started: true,
-  wait: Infinity
-};
-class Batcher {
-  constructor(fn, initialOptions) {
-    this.fn = fn;
-    this.store = new store.Store(
-      getDefaultBatcherState()
-    );
-    this.#timeoutId = null;
-    this.setOptions = (newOptions) => {
-      this.options = { ...this.options, ...newOptions };
-    };
-    this.#setState = (newState) => {
-      this.store.setState((state) => {
-        const combinedState = {
-          ...state,
-          ...newState
-        };
-        const { isPending, items } = combinedState;
-        const size = items.length;
-        const isEmpty = size === 0;
-        return {
-          ...combinedState,
-          isEmpty,
-          size,
-          status: isPending ? "pending" : "idle"
-        };
-      });
-      eventClient.emitChange("Batcher", this);
-    };
-    this.#getWait = () => {
-      return utils.parseFunctionOrValue(this.options.wait, this);
-    };
-    this.addItem = (item) => {
-      this.#setState({
-        items: [...this.store.state.items, item],
-        isPending: this.options.wait !== Infinity
-      });
-      this.options.onItemsChange?.(this);
-      const shouldProcess = this.store.state.items.length >= this.options.maxSize || this.options.getShouldExecute(this.store.state.items, this);
-      if (shouldProcess) {
-        this.#execute();
-      } else if (this.options.wait !== Infinity) {
-        this.#clearTimeout();
-        this.#timeoutId = setTimeout(() => this.#execute(), this.#getWait());
-      }
-    };
-    this.#execute = () => {
-      if (this.store.state.items.length === 0) {
-        return;
-      }
-      const batch2 = this.peekAllItems();
-      this.clear();
-      this.options.onItemsChange?.(this);
-      this.fn(batch2);
-      this.#setState({
-        executionCount: this.store.state.executionCount + 1,
-        totalItemsProcessed: this.store.state.totalItemsProcessed + batch2.length
-      });
-      this.options.onExecute?.(batch2, this);
-    };
-    this.flush = () => {
-      this.#clearTimeout();
-      this.#execute();
-    };
-    this.peekAllItems = () => {
-      return [...this.store.state.items];
-    };
-    this.#clearTimeout = () => {
-      if (this.#timeoutId) {
-        clearTimeout(this.#timeoutId);
-        this.#timeoutId = null;
-      }
-    };
-    this.clear = () => {
-      this.#setState({ items: [], isPending: false });
-    };
-    this.cancel = () => {
-      this.#clearTimeout();
-      this.#setState({ isPending: false });
-    };
-    this.reset = () => {
-      this.#setState(getDefaultBatcherState());
-      this.options.onItemsChange?.(this);
-    };
-    this.key = initialOptions.key;
-    this.options = {
-      ...defaultOptions,
-      ...initialOptions
-    };
-    this.#setState(this.options.initialState ?? {});
-    if (this.key) {
-      eventClient.pacerEventClient.on("d-Batcher", (event) => {
-        if (event.payload.key !== this.key) return;
-        this.#setState(event.payload.store.state);
-        this.setOptions(event.payload.options);
-      });
-    }
-  }
-  #timeoutId;
-  #setState;
-  #getWait;
-  #execute;
-  #clearTimeout;
-}
-function batch(fn, options) {
-  const batcher = new Batcher(fn, options);
-  return batcher.addItem;
-}
-exports.Batcher = Batcher;
-exports.batch = batch;
-//# sourceMappingURL=batcher.cjs.map

package/dist/cjs/batcher.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"batcher.cjs","sources":["../../src/batcher.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\nimport type { OptionalKeys } from './types'\n\nexport interface BatcherState<TValue> {\n  /**\n   * Number of batch executions that have been completed\n   */\n  executionCount: number\n  /**\n   * Whether the batcher has no items to process (items array is empty)\n   */\n  isEmpty: boolean\n  /**\n   * Whether the batcher is waiting for the timeout to trigger batch processing\n   */\n  isPending: boolean\n  /**\n   * Array of items currently queued for batch processing\n   */\n  items: Array<TValue>\n  /**\n   * Number of items currently in the batch queue\n   */\n  size: number\n  /**\n   * Current processing status - 'idle' when not processing, 'pending' when waiting for timeout\n   */\n  status: 'idle' | 'pending'\n  /**\n   * Total number of items that have been processed across all batches\n   */\n  totalItemsProcessed: number\n}\n\nfunction getDefaultBatcherState<TValue>(): BatcherState<TValue> {\n  return {\n    executionCount: 0,\n    isEmpty: true,\n    isPending: false,\n    totalItemsProcessed: 0,\n    items: [],\n    size: 0,\n    status: 'idle',\n  }\n}\n\n/**\n * Options for configuring a Batcher instance\n */\nexport interface BatcherOptions<TValue> {\n  /**\n   * Custom function to determine if a batch should be processed\n   * Return true to process the batch immediately\n   */\n  getShouldExecute?: (items: Array<TValue>, batcher: Batcher<TValue>) => boolean\n  /**\n   * Initial state for the batcher\n   */\n  initialState?: Partial<BatcherState<TValue>>\n  /**\n   * Optional key to identify this batcher instance.\n   * If provided, the batcher will be identified by this key in the devtools and PacerProvider if applicable.\n   */\n  key?: string\n  /**\n   * Maximum number of items in a batch\n   * @default Infinity\n   */\n  maxSize?: number\n  /**\n   * Callback fired after a batch is processed\n   */\n  onExecute?: (batch: Array<TValue>, batcher: Batcher<TValue>) => void\n  /**\n   * Callback fired after items are added to the batcher\n   */\n  onItemsChange?: (batcher: Batcher<TValue>) => void\n  /**\n   * Whether the batcher should start processing immediately\n   * @default true\n   */\n  started?: boolean\n  /**\n   * Maximum time in milliseconds to wait before processing a batch.\n   * If the wait duration has elapsed, the batch will be processed.\n   * If not provided, the batch will not be triggered by a timeout.\n   * @default Infinity\n   */\n  wait?: number | ((batcher: Batcher<TValue>) => number)\n}\n\ntype BatcherOptionsWithOptionalCallbacks<TValue> = OptionalKeys<\n  Required<BatcherOptions<TValue>>,\n  'initialState' | 'onExecute' | 'onItemsChange' | 'key'\n>\n\nconst defaultOptions: BatcherOptionsWithOptionalCallbacks<any> = {\n  getShouldExecute: () => false,\n  maxSize: Infinity,\n  started: true,\n  wait: Infinity,\n}\n\n/**\n * A class that collects items and processes them in batches.\n *\n * Batching is a technique for grouping multiple operations together to be processed as a single unit.\n * This synchronous version is lighter weight and often all you need - upgrade to AsyncBatcher when you need promises, retry support, abort/cancel capabilities, or advanced error handling.\n *\n * The Batcher provides a flexible way to implement batching with configurable:\n * - Maximum batch size (number of items per batch)\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\n * - Event callbacks for monitoring batch operations\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the batcher\n * - Use `onExecute` callback to react to batch execution and implement custom logic\n * - Use `onItemsChange` callback to react to items being added or removed from the batcher\n * - The state includes batch execution count, total items processed, items, and running status\n * - State can be accessed via `batcher.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `batcher.state`\n *\n * @example\n * ```ts\n * const batcher = new Batcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   {\n *     maxSize: 5,\n *     wait: 2000,\n *     onExecute: (batch, batcher) => console.log('Batch executed:', batch)\n *   }\n * );\n *\n * batcher.addItem(1);\n * batcher.addItem(2);\n * // After 2 seconds or when 5 items are added, whichever comes first,\n * // the batch will be processed\n * // batcher.flush() // manually trigger a batch\n * ```\n */\nexport class Batcher<TValue> {\n  readonly store: Store<Readonly<BatcherState<TValue>>> = new Store(\n    getDefaultBatcherState<TValue>(),\n  )\n  key: string | undefined\n  options: BatcherOptionsWithOptionalCallbacks<TValue>\n  #timeoutId: NodeJS.Timeout | null = null\n\n  constructor(\n    public fn: (items: Array<TValue>) => void,\n    initialOptions: BatcherOptions<TValue>,\n  ) {\n    this.key = initialOptions.key\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n    this.#setState(this.options.initialState ?? {})\n\n    if (this.key) {\n      pacerEventClient.on('d-Batcher', (event) => {\n        if (event.payload.key !== this.key) return\n        this.#setState(event.payload.store.state)\n        this.setOptions(event.payload.options)\n      })\n    }\n  }\n\n  /**\n   * Updates the batcher options\n   */\n  setOptions = (newOptions: Partial<BatcherOptions<TValue>>): void => {\n    this.options = { ...this.options, ...newOptions }\n  }\n\n  #setState = (newState: Partial<BatcherState<TValue>>): void => {\n    this.store.setState((state) => {\n      const combinedState = {\n        ...state,\n        ...newState,\n      }\n      const { isPending, items } = combinedState\n      const size = items.length\n      const isEmpty = size === 0\n      return {\n        ...combinedState,\n        isEmpty,\n        size,\n        status: isPending ? 'pending' : 'idle',\n      }\n    })\n    emitChange('Batcher', this)\n  }\n\n  #getWait = (): number => {\n    return parseFunctionOrValue(this.options.wait, this)\n  }\n\n  /**\n   * Adds an item to the batcher\n   * If the batch size is reached, timeout occurs, or shouldProcess returns true, the batch will be processed\n   */\n  addItem = (item: TValue): void => {\n    this.#setState({\n      items: [...this.store.state.items, item],\n      isPending: this.options.wait !== Infinity,\n    })\n    this.options.onItemsChange?.(this)\n\n    const shouldProcess =\n      this.store.state.items.length >= this.options.maxSize ||\n      this.options.getShouldExecute(this.store.state.items, this)\n\n    if (shouldProcess) {\n      this.#execute()\n    } else if (this.options.wait !== Infinity) {\n      this.#clearTimeout() // clear any pending timeout to replace it with a new one\n      this.#timeoutId = setTimeout(() => this.#execute(), this.#getWait())\n    }\n  }\n\n  /**\n   * Processes the current batch of items.\n   * This method will automatically be triggered if the batcher is running and any of these conditions are met:\n   * - The number of items reaches batchSize\n   * - The wait duration has elapsed\n   * - The getShouldExecute function returns true upon adding an item\n   *\n   * You can also call this method manually to process the current batch at any time.\n   */\n  #execute = (): void => {\n    if (this.store.state.items.length === 0) {\n      return\n    }\n\n    const batch = this.peekAllItems() // copy of the items to be processed (to prevent race conditions)\n    this.clear() // Clear items before processing to prevent race conditions\n    this.options.onItemsChange?.(this) // Call onItemsChange to notify listeners that the items have changed\n\n    this.fn(batch) // EXECUTE\n    this.#setState({\n      executionCount: this.store.state.executionCount + 1,\n      totalItemsProcessed: this.store.state.totalItemsProcessed + batch.length,\n    })\n    this.options.onExecute?.(batch, this)\n  }\n\n  /**\n   * Processes the current batch of items immediately\n   */\n  flush = (): void => {\n    this.#clearTimeout() // clear any pending timeout\n    this.#execute() // execute immediately\n  }\n\n  /**\n   * Returns a copy of all items in the batcher\n   */\n  peekAllItems = (): Array<TValue> => {\n    return [...this.store.state.items]\n  }\n\n  #clearTimeout = (): void => {\n    if (this.#timeoutId) {\n      clearTimeout(this.#timeoutId)\n      this.#timeoutId = null\n    }\n  }\n\n  /**\n   * Removes all items from the batcher\n   */\n  clear = (): void => {\n    this.#setState({ items: [], isPending: false })\n  }\n\n  /**\n   * Cancels any pending execution that was scheduled.\n   * Does NOT clear out the items.\n   */\n  cancel = (): void => {\n    this.#clearTimeout()\n    this.#setState({ isPending: false })\n  }\n\n  /**\n   * Resets the batcher state to its default values\n   */\n  reset = (): void => {\n    this.#setState(getDefaultBatcherState<TValue>())\n    this.options.onItemsChange?.(this)\n  }\n}\n\n/**\n * Creates a batcher that processes items in batches.\n *\n * This synchronous version is lighter weight and often all you need - upgrade to asyncBatch when you need promises, retry support, abort/cancel capabilities, or advanced error handling.\n *\n * @example\n * ```ts\n * const batchItems = batch<number>(\n *   (items) => console.log('Processing:', items),\n *   {\n *     maxSize: 3,\n *     onExecute: (batch, batcher) => console.log('Batch executed:', batch)\n *   }\n * );\n *\n * batchItems(1);\n * batchItems(2);\n * batchItems(3); // Triggers batch processing\n * ```\n */\nexport function batch<TValue>(\n  fn: (items: Array<TValue>) => void,\n  options: BatcherOptions<TValue>,\n) {\n  const batcher = new Batcher<TValue>(fn, options)\n  return batcher.addItem\n}\n"],"names":["Store","emitChange","parseFunctionOrValue","batch","pacerEventClient"],"mappings":";;;;;AAoCA,SAAS,yBAAuD;AAC9D,SAAO;AAAA,IACL,gBAAgB;AAAA,IAChB,SAAS;AAAA,IACT,WAAW;AAAA,IACX,qBAAqB;AAAA,IACrB,OAAO,CAAA;AAAA,IACP,MAAM;AAAA,IACN,QAAQ;AAAA,EAAA;AAEZ;AAoDA,MAAM,iBAA2D;AAAA,EAC/D,kBAAkB,MAAM;AAAA,EACxB,SAAS;AAAA,EACT,SAAS;AAAA,EACT,MAAM;AACR;AAyCO,MAAM,QAAgB;AAAA,EAQ3B,YACS,IACP,gBACA;AAFO,SAAA,KAAA;AART,SAAS,QAA+C,IAAIA,MAAAA;AAAAA,MAC1D,uBAAA;AAAA,IAA+B;AAIjC,SAAA,aAAoC;AAyBpC,SAAA,aAAa,CAAC,eAAsD;AAClE,WAAK,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,WAAA;AAAA,IACvC;AAEA,SAAA,YAAY,CAAC,aAAkD;AAC7D,WAAK,MAAM,SAAS,CAAC,UAAU;AAC7B,cAAM,gBAAgB;AAAA,UACpB,GAAG;AAAA,UACH,GAAG;AAAA,QAAA;AAEL,cAAM,EAAE,WAAW,MAAA,IAAU;AAC7B,cAAM,OAAO,MAAM;AACnB,cAAM,UAAU,SAAS;AACzB,eAAO;AAAA,UACL,GAAG;AAAA,UACH;AAAA,UACA;AAAA,UACA,QAAQ,YAAY,YAAY;AAAA,QAAA;AAAA,MAEpC,CAAC;AACDC,kBAAAA,WAAW,WAAW,IAAI;AAAA,IAC5B;AAEA,SAAA,WAAW,MAAc;AACvB,aAAOC,MAAAA,qBAAqB,KAAK,QAAQ,MAAM,IAAI;AAAA,IACrD;AAMA,SAAA,UAAU,CAAC,SAAuB;AAChC,WAAK,UAAU;AAAA,QACb,OAAO,CAAC,GAAG,KAAK,MAAM,MAAM,OAAO,IAAI;AAAA,QACvC,WAAW,KAAK,QAAQ,SAAS;AAAA,MAAA,CAClC;AACD,WAAK,QAAQ,gBAAgB,IAAI;AAEjC,YAAM,gBACJ,KAAK,MAAM,MAAM,MAAM,UAAU,KAAK,QAAQ,WAC9C,KAAK,QAAQ,iBAAiB,KAAK,MAAM,MAAM,OAAO,IAAI;AAE5D,UAAI,eAAe;AACjB,aAAK,SAAA;AAAA,MACP,WAAW,KAAK,QAAQ,SAAS,UAAU;AACzC,aAAK,cAAA;AACL,aAAK,aAAa,WAAW,MAAM,KAAK,YAAY,KAAK,UAAU;AAAA,MACrE;AAAA,IACF;AAWA,SAAA,WAAW,MAAY;AACrB,UAAI,KAAK,MAAM,MAAM,MAAM,WAAW,GAAG;AACvC;AAAA,MACF;AAEA,YAAMC,SAAQ,KAAK,aAAA;AACnB,WAAK,MAAA;AACL,WAAK,QAAQ,gBAAgB,IAAI;AAEjC,WAAK,GAAGA,MAAK;AACb,WAAK,UAAU;AAAA,QACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB;AAAA,QAClD,qBAAqB,KAAK,MAAM,MAAM,sBAAsBA,OAAM;AAAA,MAAA,CACnE;AACD,WAAK,QAAQ,YAAYA,QAAO,IAAI;AAAA,IACtC;AAKA,SAAA,QAAQ,MAAY;AAClB,WAAK,cAAA;AACL,WAAK,SAAA;AAAA,IACP;AAKA,SAAA,eAAe,MAAqB;AAClC,aAAO,CAAC,GAAG,KAAK,MAAM,MAAM,KAAK;AAAA,IACnC;AAEA,SAAA,gBAAgB,MAAY;AAC1B,UAAI,KAAK,YAAY;AACnB,qBAAa,KAAK,UAAU;AAC5B,aAAK,aAAa;AAAA,MACpB;AAAA,IACF;AAKA,SAAA,QAAQ,MAAY;AAClB,WAAK,UAAU,EAAE,OAAO,CAAA,GAAI,WAAW,OAAO;AAAA,IAChD;AAMA,SAAA,SAAS,MAAY;AACnB,WAAK,cAAA;AACL,WAAK,UAAU,EAAE,WAAW,MAAA,CAAO;AAAA,IACrC;AAKA,SAAA,QAAQ,MAAY;AAClB,WAAK,UAAU,wBAAgC;AAC/C,WAAK,QAAQ,gBAAgB,IAAI;AAAA,IACnC;AA3IE,SAAK,MAAM,eAAe;AAC1B,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,MACH,GAAG;AAAA,IAAA;AAEL,SAAK,UAAU,KAAK,QAAQ,gBAAgB,CAAA,CAAE;AAE9C,QAAI,KAAK,KAAK;AACZC,kBAAAA,iBAAiB,GAAG,aAAa,CAAC,UAAU;AAC1C,YAAI,MAAM,QAAQ,QAAQ,KAAK,IAAK;AACpC,aAAK,UAAU,MAAM,QAAQ,MAAM,KAAK;AACxC,aAAK,WAAW,MAAM,QAAQ,OAAO;AAAA,MACvC,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EApBA;AAAA,EA6BA;AAAA,EAmBA;AAAA,EAoCA;AAAA,EAgCA;AA8BF;AAsBO,SAAS,MACd,IACA,SACA;AACA,QAAM,UAAU,IAAI,QAAgB,IAAI,OAAO;AAC/C,SAAO,QAAQ;AACjB;;;"}

package/dist/cjs/batcher.d.cts

@@ -1,176 +0,0 @@
-import { Store } from '@tanstack/store';
-import { OptionalKeys } from './types.cjs';
-export interface BatcherState<TValue> {
-    /**
-     * Number of batch executions that have been completed
-     */
-    executionCount: number;
-    /**
-     * Whether the batcher has no items to process (items array is empty)
-     */
-    isEmpty: boolean;
-    /**
-     * Whether the batcher is waiting for the timeout to trigger batch processing
-     */
-    isPending: boolean;
-    /**
-     * Array of items currently queued for batch processing
-     */
-    items: Array<TValue>;
-    /**
-     * Number of items currently in the batch queue
-     */
-    size: number;
-    /**
-     * Current processing status - 'idle' when not processing, 'pending' when waiting for timeout
-     */
-    status: 'idle' | 'pending';
-    /**
-     * Total number of items that have been processed across all batches
-     */
-    totalItemsProcessed: number;
-}
-/**
- * Options for configuring a Batcher instance
- */
-export interface BatcherOptions<TValue> {
-    /**
-     * Custom function to determine if a batch should be processed
-     * Return true to process the batch immediately
-     */
-    getShouldExecute?: (items: Array<TValue>, batcher: Batcher<TValue>) => boolean;
-    /**
-     * Initial state for the batcher
-     */
-    initialState?: Partial<BatcherState<TValue>>;
-    /**
-     * Optional key to identify this batcher instance.
-     * If provided, the batcher will be identified by this key in the devtools and PacerProvider if applicable.
-     */
-    key?: string;
-    /**
-     * Maximum number of items in a batch
-     * @default Infinity
-     */
-    maxSize?: number;
-    /**
-     * Callback fired after a batch is processed
-     */
-    onExecute?: (batch: Array<TValue>, batcher: Batcher<TValue>) => void;
-    /**
-     * Callback fired after items are added to the batcher
-     */
-    onItemsChange?: (batcher: Batcher<TValue>) => void;
-    /**
-     * Whether the batcher should start processing immediately
-     * @default true
-     */
-    started?: boolean;
-    /**
-     * Maximum time in milliseconds to wait before processing a batch.
-     * If the wait duration has elapsed, the batch will be processed.
-     * If not provided, the batch will not be triggered by a timeout.
-     * @default Infinity
-     */
-    wait?: number | ((batcher: Batcher<TValue>) => number);
-}
-type BatcherOptionsWithOptionalCallbacks<TValue> = OptionalKeys<Required<BatcherOptions<TValue>>, 'initialState' | 'onExecute' | 'onItemsChange' | 'key'>;
-/**
- * A class that collects items and processes them in batches.
- *
- * Batching is a technique for grouping multiple operations together to be processed as a single unit.
- * This synchronous version is lighter weight and often all you need - upgrade to AsyncBatcher when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
- *
- * The Batcher provides a flexible way to implement batching with configurable:
- * - Maximum batch size (number of items per batch)
- * - Time-based batching (process after X milliseconds)
- * - Custom batch processing logic via getShouldExecute
- * - Event callbacks for monitoring batch operations
- *
- * State Management:
- * - Uses TanStack Store for reactive state management
- * - Use `initialState` to provide initial state values when creating the batcher
- * - Use `onExecute` callback to react to batch execution and implement custom logic
- * - Use `onItemsChange` callback to react to items being added or removed from the batcher
- * - The state includes batch execution count, total items processed, items, and running status
- * - State can be accessed via `batcher.store.state` when using the class directly
- * - When using framework adapters (React/Solid), state is accessed from `batcher.state`
- *
- * @example
- * ```ts
- * const batcher = new Batcher<number>(
- *   (items) => console.log('Processing batch:', items),
- *   {
- *     maxSize: 5,
- *     wait: 2000,
- *     onExecute: (batch, batcher) => console.log('Batch executed:', batch)
- *   }
- * );
- *
- * batcher.addItem(1);
- * batcher.addItem(2);
- * // After 2 seconds or when 5 items are added, whichever comes first,
- * // the batch will be processed
- * // batcher.flush() // manually trigger a batch
- * ```
- */
-export declare class Batcher<TValue> {
-    #private;
-    fn: (items: Array<TValue>) => void;
-    readonly store: Store<Readonly<BatcherState<TValue>>>;
-    key: string | undefined;
-    options: BatcherOptionsWithOptionalCallbacks<TValue>;
-    constructor(fn: (items: Array<TValue>) => void, initialOptions: BatcherOptions<TValue>);
-    /**
-     * Updates the batcher options
-     */
-    setOptions: (newOptions: Partial<BatcherOptions<TValue>>) => void;
-    /**
-     * Adds an item to the batcher
-     * If the batch size is reached, timeout occurs, or shouldProcess returns true, the batch will be processed
-     */
-    addItem: (item: TValue) => void;
-    /**
-     * Processes the current batch of items immediately
-     */
-    flush: () => void;
-    /**
-     * Returns a copy of all items in the batcher
-     */
-    peekAllItems: () => Array<TValue>;
-    /**
-     * Removes all items from the batcher
-     */
-    clear: () => void;
-    /**
-     * Cancels any pending execution that was scheduled.
-     * Does NOT clear out the items.
-     */
-    cancel: () => void;
-    /**
-     * Resets the batcher state to its default values
-     */
-    reset: () => void;
-}
-/**
- * Creates a batcher that processes items in batches.
- *
- * This synchronous version is lighter weight and often all you need - upgrade to asyncBatch when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
- *
- * @example
- * ```ts
- * const batchItems = batch<number>(
- *   (items) => console.log('Processing:', items),
- *   {
- *     maxSize: 3,
- *     onExecute: (batch, batcher) => console.log('Batch executed:', batch)
- *   }
- * );
- *
- * batchItems(1);
- * batchItems(2);
- * batchItems(3); // Triggers batch processing
- * ```
- */
-export declare function batch<TValue>(fn: (items: Array<TValue>) => void, options: BatcherOptions<TValue>): (item: TValue) => void;
-export {};