@tanstack/pacer 0.16.0 → 0.16.1

package/src/async-retryer.ts

@@ -1,5 +1,5 @@
 import { Store } from '@tanstack/store'
-import { createKey, parseFunctionOrValue } from './utils'
+import { parseFunctionOrValue } from './utils'
 import { emitChange, pacerEventClient } from './event-client'
 import type { AnyAsyncFunction } from './types'
 
@@ -289,7 +289,7 @@ export class AsyncRetryer<TFn extends AnyAsyncFunction> {
   readonly store: Store<Readonly<AsyncRetryerState<TFn>>> = new Store(
     getDefaultAsyncRetryerState<TFn>(),
   )
-  key: string
+  key: string | undefined
   options: AsyncRetryerOptions<TFn> & typeof defaultOptions
   #abortController: AbortController | null = null
 
@@ -302,7 +302,7 @@ export class AsyncRetryer<TFn extends AnyAsyncFunction> {
     public fn: TFn,
     initialOptions: AsyncRetryerOptions<TFn> = {},
   ) {
-    this.key = createKey(initialOptions.key)
+    this.key = initialOptions.key
     this.options = {
       ...defaultOptions,
       ...initialOptions,
@@ -319,11 +319,6 @@ export class AsyncRetryer<TFn extends AnyAsyncFunction> {
     })
   }
 
-  /**
-   * Emits a change event for the async retryer instance. Mostly useful for devtools.
-   */
-  _emit = () => emitChange('AsyncRetryer', this)
-
   /**
    * Updates the retryer options
    * @param newOptions Partial options to merge with existing options

package/src/async-throttler.ts

@@ -1,6 +1,6 @@
 import { Store } from '@tanstack/store'
 import { AsyncRetryer } from './async-retryer'
-import { createKey, parseFunctionOrValue } from './utils'
+import { parseFunctionOrValue } from './utils'
 import { emitChange, pacerEventClient } from './event-client'
 import type { AsyncRetryerOptions } from './async-retryer'
 import type { AnyAsyncFunction, OptionalKeys } from './types'
@@ -231,7 +231,7 @@ export class AsyncThrottler<TFn extends AnyAsyncFunction> {
   readonly store: Store<Readonly<AsyncThrottlerState<TFn>>> = new Store<
     AsyncThrottlerState<TFn>
   >(getDefaultAsyncThrottlerState<TFn>())
-  key: string
+  key: string | undefined
   options: AsyncThrottlerOptions<TFn>
   asyncRetryers = new Map<number, AsyncRetryer<TFn>>()
   #timeoutId: NodeJS.Timeout | null = null
@@ -243,7 +243,7 @@ export class AsyncThrottler<TFn extends AnyAsyncFunction> {
     public fn: TFn,
     initialOptions: AsyncThrottlerOptions<TFn>,
   ) {
-    this.key = createKey(initialOptions.key)
+    this.key = initialOptions.key
     this.options = {
       ...defaultOptions,
       ...initialOptions,
@@ -258,11 +258,6 @@ export class AsyncThrottler<TFn extends AnyAsyncFunction> {
     })
   }
 
-  /**
-   * Emits a change event for the async throttler instance. Mostly useful for devtools.
-   */
-  _emit = () => emitChange('AsyncThrottler', this)
-
   /**
    * Updates the async throttler options
    */

package/src/batcher.ts

@@ -1,5 +1,5 @@
 import { Store } from '@tanstack/store'
-import { createKey, parseFunctionOrValue } from './utils'
+import { parseFunctionOrValue } from './utils'
 import { emitChange, pacerEventClient } from './event-client'
 import type { OptionalKeys } from './types'
 
@@ -146,7 +146,7 @@ export class Batcher<TValue> {
   readonly store: Store<Readonly<BatcherState<TValue>>> = new Store(
     getDefaultBatcherState<TValue>(),
   )
-  key: string
+  key: string | undefined
   options: BatcherOptionsWithOptionalCallbacks<TValue>
   #timeoutId: NodeJS.Timeout | null = null
 
@@ -154,7 +154,7 @@ export class Batcher<TValue> {
     public fn: (items: Array<TValue>) => void,
     initialOptions: BatcherOptions<TValue>,
   ) {
-    this.key = createKey(initialOptions.key)
+    this.key = initialOptions.key
     this.options = {
       ...defaultOptions,
       ...initialOptions,
@@ -168,11 +168,6 @@ export class Batcher<TValue> {
     })
   }
 
-  /**
-   * Emits a change event for the batcher instance. Mostly useful for devtools.
-   */
-  _emit = () => emitChange('Batcher', this)
-
   /**
    * Updates the batcher options
    */

package/src/debouncer.ts

@@ -1,5 +1,5 @@
 import { Store } from '@tanstack/store'
-import { createKey, parseFunctionOrValue } from './utils'
+import { parseFunctionOrValue } from './utils'
 import { emitChange, pacerEventClient } from './event-client'
 import type { AnyFunction } from './types'
 
@@ -143,7 +143,7 @@ export class Debouncer<TFn extends AnyFunction> {
   readonly store: Store<Readonly<DebouncerState<TFn>>> = new Store(
     getDefaultDebouncerState<TFn>(),
   )
-  key: string
+  key: string | undefined
   options: DebouncerOptions<TFn>
   #timeoutId: NodeJS.Timeout | undefined
 
@@ -151,7 +151,7 @@ export class Debouncer<TFn extends AnyFunction> {
     public fn: TFn,
     initialOptions: DebouncerOptions<TFn>,
   ) {
-    this.key = createKey(initialOptions.key)
+    this.key = initialOptions.key
     this.options = {
       ...defaultOptions,
       ...initialOptions,
@@ -165,11 +165,6 @@ export class Debouncer<TFn extends AnyFunction> {
     })
   }
 
-  /**
-   * Emits a change event for the debouncer instance. Mostly useful for devtools.
-   */
-  _emit = () => emitChange('Debouncer', this)
-
   /**
    * Updates the debouncer options
    */

package/src/event-client.ts

@@ -60,7 +60,9 @@ export const emitChange = <
   event: TSuffix,
   payload: PacerEventMap[`pacer:${TSuffix}`],
 ) => {
-  pacerEventClient.emit(event, payload)
+  if (payload.key) {
+    pacerEventClient.emit(event, payload)
+  }
 }
 
 export const pacerEventClient = new PacerEventClient()

package/src/queuer.ts

@@ -1,5 +1,5 @@
 import { Store } from '@tanstack/store'
-import { createKey, parseFunctionOrValue } from './utils'
+import { parseFunctionOrValue } from './utils'
 import { emitChange, pacerEventClient } from './event-client'
 
 export interface QueuerState<TValue> {
@@ -270,7 +270,7 @@ export class Queuer<TValue> {
   readonly store: Store<Readonly<QueuerState<TValue>>> = new Store(
     getDefaultQueuerState<TValue>(),
   )
-  key: string
+  key: string | undefined
   options: QueuerOptions<TValue>
   #timeoutId: NodeJS.Timeout | null = null
 
@@ -278,7 +278,7 @@ export class Queuer<TValue> {
     public fn: (item: TValue) => void,
     initialOptions: QueuerOptions<TValue> = {},
   ) {
-    this.key = createKey(initialOptions.key)
+    this.key = initialOptions.key
     this.options = {
       ...defaultOptions,
       ...initialOptions,
@@ -309,11 +309,6 @@ export class Queuer<TValue> {
     })
   }
 
-  /**
-   * Emits a change event for the queuer instance. Mostly useful for devtools.
-   */
-  _emit = () => emitChange('Queuer', this)
-
   /**
    * Updates the queuer options. New options are merged with existing options.
    */

package/src/rate-limiter.ts

@@ -1,5 +1,5 @@
 import { Store } from '@tanstack/store'
-import { createKey, parseFunctionOrValue } from './utils'
+import { parseFunctionOrValue } from './utils'
 import { emitChange, pacerEventClient } from './event-client'
 import type { AnyFunction } from './types'
 
@@ -156,7 +156,7 @@ const defaultOptions: Omit<
 export class RateLimiter<TFn extends AnyFunction> {
   readonly store: Store<Readonly<RateLimiterState>> =
     new Store<RateLimiterState>(getDefaultRateLimiterState())
-  key: string
+  key: string | undefined
   options: RateLimiterOptions<TFn>
   #timeoutIds: Set<NodeJS.Timeout> = new Set()
 
@@ -164,7 +164,7 @@ export class RateLimiter<TFn extends AnyFunction> {
     public fn: TFn,
     initialOptions: RateLimiterOptions<TFn>,
   ) {
-    this.key = createKey(initialOptions.key)
+    this.key = initialOptions.key
     this.options = {
       ...defaultOptions,
       ...initialOptions,
@@ -181,11 +181,6 @@ export class RateLimiter<TFn extends AnyFunction> {
     })
   }
 
-  /**
-   * Emits a change event for the rate limiter instance. Mostly useful for devtools.
-   */
-  _emit = () => emitChange('RateLimiter', this)
-
   /**
    * Updates the rate limiter options
    */

package/src/throttler.ts

@@ -1,5 +1,5 @@
 import { Store } from '@tanstack/store'
-import { createKey, parseFunctionOrValue } from './utils'
+import { parseFunctionOrValue } from './utils'
 import { emitChange, pacerEventClient } from './event-client'
 import type { AnyFunction } from './types'
 
@@ -159,7 +159,7 @@ export class Throttler<TFn extends AnyFunction> {
     public fn: TFn,
     initialOptions: ThrottlerOptions<TFn>,
   ) {
-    this.key = createKey(initialOptions.key)
+    this.key = initialOptions.key
     this.options = {
       ...defaultOptions,
       ...initialOptions,
@@ -173,11 +173,6 @@ export class Throttler<TFn extends AnyFunction> {
     })
   }
 
-  /**
-   * Emits a change event for the throttler instance. Mostly useful for devtools.
-   */
-  _emit = () => emitChange('Throttler', this)
-
   /**
    * Updates the throttler options
    */

package/src/utils.ts

@@ -10,18 +10,3 @@ export function parseFunctionOrValue<T, TArgs extends Array<any>>(
 ): T {
   return isFunction(value) ? value(...args) : value
 }
-
-export function createKey(key?: string): string {
-  if (key) {
-    return key
-  }
-
-  if (
-    typeof crypto !== 'undefined' &&
-    typeof crypto.randomUUID === 'function'
-  ) {
-    return crypto.randomUUID()
-  }
-
-  return ''
-}