@tanstack/solid-pacer 0.16.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/async-batcher/createAsyncBatcher.cjs +122 -0
- package/dist/async-batcher/createAsyncBatcher.cjs.map +1 -0
- package/dist/{cjs/async-batcher → async-batcher}/createAsyncBatcher.d.cts +22 -17
- package/dist/{esm/async-batcher → async-batcher}/createAsyncBatcher.d.ts +22 -17
- package/dist/async-batcher/createAsyncBatcher.js +122 -0
- package/dist/async-batcher/createAsyncBatcher.js.map +1 -0
- package/dist/async-batcher/index.cjs +10 -0
- package/dist/async-batcher/index.d.cts +3 -0
- package/dist/async-batcher/index.d.ts +3 -0
- package/dist/async-batcher/index.js +5 -0
- package/dist/async-debouncer/createAsyncDebouncer.cjs +114 -0
- package/dist/async-debouncer/createAsyncDebouncer.cjs.map +1 -0
- package/dist/{cjs/async-debouncer → async-debouncer}/createAsyncDebouncer.d.cts +23 -18
- package/dist/{esm/async-debouncer → async-debouncer}/createAsyncDebouncer.d.ts +23 -18
- package/dist/async-debouncer/createAsyncDebouncer.js +114 -0
- package/dist/async-debouncer/createAsyncDebouncer.js.map +1 -0
- package/dist/async-debouncer/index.cjs +10 -0
- package/dist/async-debouncer/index.d.cts +3 -0
- package/dist/async-debouncer/index.d.ts +3 -0
- package/dist/async-debouncer/index.js +5 -0
- package/dist/async-queuer/createAsyncQueuer.cjs +114 -0
- package/dist/async-queuer/createAsyncQueuer.cjs.map +1 -0
- package/dist/{cjs/async-queuer → async-queuer}/createAsyncQueuer.d.cts +22 -17
- package/dist/{esm/async-queuer → async-queuer}/createAsyncQueuer.d.ts +22 -17
- package/dist/async-queuer/createAsyncQueuer.js +114 -0
- package/dist/async-queuer/createAsyncQueuer.js.map +1 -0
- package/dist/async-queuer/index.cjs +10 -0
- package/dist/async-queuer/index.d.cts +3 -0
- package/dist/async-queuer/index.d.ts +3 -0
- package/dist/async-queuer/index.js +5 -0
- package/dist/async-rate-limiter/createAsyncRateLimiter.cjs +120 -0
- package/dist/async-rate-limiter/createAsyncRateLimiter.cjs.map +1 -0
- package/dist/{cjs/async-rate-limiter → async-rate-limiter}/createAsyncRateLimiter.d.cts +23 -18
- package/dist/{esm/async-rate-limiter → async-rate-limiter}/createAsyncRateLimiter.d.ts +23 -18
- package/dist/async-rate-limiter/createAsyncRateLimiter.js +120 -0
- package/dist/async-rate-limiter/createAsyncRateLimiter.js.map +1 -0
- package/dist/async-rate-limiter/index.cjs +10 -0
- package/dist/async-rate-limiter/index.d.cts +3 -0
- package/dist/async-rate-limiter/index.d.ts +3 -0
- package/dist/async-rate-limiter/index.js +5 -0
- package/dist/async-throttler/createAsyncThrottler.cjs +108 -0
- package/dist/async-throttler/createAsyncThrottler.cjs.map +1 -0
- package/dist/{cjs/async-throttler → async-throttler}/createAsyncThrottler.d.cts +23 -18
- package/dist/{esm/async-throttler → async-throttler}/createAsyncThrottler.d.ts +23 -18
- package/dist/async-throttler/createAsyncThrottler.js +108 -0
- package/dist/async-throttler/createAsyncThrottler.js.map +1 -0
- package/dist/async-throttler/index.cjs +10 -0
- package/dist/async-throttler/index.d.cts +3 -0
- package/dist/async-throttler/index.d.ts +3 -0
- package/dist/async-throttler/index.js +5 -0
- package/dist/batcher/createBatcher.cjs +97 -0
- package/dist/batcher/createBatcher.cjs.map +1 -0
- package/dist/{cjs/batcher → batcher}/createBatcher.d.cts +22 -17
- package/dist/{esm/batcher → batcher}/createBatcher.d.ts +22 -17
- package/dist/batcher/createBatcher.js +97 -0
- package/dist/batcher/createBatcher.js.map +1 -0
- package/dist/batcher/index.cjs +10 -0
- package/dist/batcher/index.d.cts +3 -0
- package/dist/batcher/index.d.ts +3 -0
- package/dist/batcher/index.js +5 -0
- package/dist/debouncer/createDebouncedSignal.cjs +88 -0
- package/dist/debouncer/createDebouncedSignal.cjs.map +1 -0
- package/dist/{cjs/debouncer → debouncer}/createDebouncedSignal.d.cts +10 -8
- package/dist/{esm/debouncer → debouncer}/createDebouncedSignal.d.ts +10 -8
- package/dist/debouncer/createDebouncedSignal.js +88 -0
- package/dist/debouncer/createDebouncedSignal.js.map +1 -0
- package/dist/debouncer/createDebouncedValue.cjs +77 -0
- package/dist/debouncer/createDebouncedValue.cjs.map +1 -0
- package/dist/{cjs/debouncer → debouncer}/createDebouncedValue.d.cts +10 -4
- package/dist/{esm/debouncer → debouncer}/createDebouncedValue.d.ts +10 -4
- package/dist/debouncer/createDebouncedValue.js +77 -0
- package/dist/debouncer/createDebouncedValue.js.map +1 -0
- package/dist/debouncer/createDebouncer.cjs +101 -0
- package/dist/debouncer/createDebouncer.cjs.map +1 -0
- package/dist/{cjs/debouncer → debouncer}/createDebouncer.d.cts +23 -18
- package/dist/{esm/debouncer → debouncer}/createDebouncer.d.ts +23 -18
- package/dist/debouncer/createDebouncer.js +101 -0
- package/dist/debouncer/createDebouncer.js.map +1 -0
- package/dist/debouncer/index.cjs +14 -0
- package/dist/debouncer/index.d.cts +5 -0
- package/dist/debouncer/index.d.ts +5 -0
- package/dist/{esm/debouncer → debouncer}/index.js +5 -8
- package/dist/index.cjs +46 -0
- package/dist/index.d.cts +20 -0
- package/dist/index.d.ts +20 -0
- package/dist/{esm/index.js → index.js} +6 -26
- package/dist/provider/PacerProvider.cjs +27 -0
- package/dist/provider/PacerProvider.cjs.map +1 -0
- package/dist/provider/PacerProvider.d.cts +29 -0
- package/dist/provider/PacerProvider.d.ts +29 -0
- package/dist/provider/PacerProvider.js +25 -0
- package/dist/provider/PacerProvider.js.map +1 -0
- package/dist/provider/index.cjs +5 -0
- package/dist/provider/index.d.cts +2 -0
- package/dist/provider/index.d.ts +2 -0
- package/dist/provider/index.js +3 -0
- package/dist/queuer/createQueuedSignal.cjs +129 -0
- package/dist/queuer/createQueuedSignal.cjs.map +1 -0
- package/dist/{cjs/queuer → queuer}/createQueuedSignal.d.cts +9 -7
- package/dist/{esm/queuer → queuer}/createQueuedSignal.d.ts +9 -7
- package/dist/queuer/createQueuedSignal.js +129 -0
- package/dist/queuer/createQueuedSignal.js.map +1 -0
- package/dist/queuer/createQueuer.cjs +98 -0
- package/dist/queuer/createQueuer.cjs.map +1 -0
- package/dist/{cjs/queuer → queuer}/createQueuer.d.cts +22 -17
- package/dist/{esm/queuer → queuer}/createQueuer.d.ts +22 -17
- package/dist/queuer/createQueuer.js +98 -0
- package/dist/queuer/createQueuer.js.map +1 -0
- package/dist/queuer/index.cjs +12 -0
- package/dist/queuer/index.d.cts +4 -0
- package/dist/queuer/index.d.ts +4 -0
- package/dist/queuer/index.js +6 -0
- package/dist/rate-limiter/createRateLimitedSignal.cjs +102 -0
- package/dist/rate-limiter/createRateLimitedSignal.cjs.map +1 -0
- package/dist/{cjs/rate-limiter → rate-limiter}/createRateLimitedSignal.d.cts +10 -8
- package/dist/{esm/rate-limiter → rate-limiter}/createRateLimitedSignal.d.ts +10 -8
- package/dist/rate-limiter/createRateLimitedSignal.js +102 -0
- package/dist/rate-limiter/createRateLimitedSignal.js.map +1 -0
- package/dist/rate-limiter/createRateLimitedValue.cjs +102 -0
- package/dist/rate-limiter/createRateLimitedValue.cjs.map +1 -0
- package/dist/{cjs/rate-limiter → rate-limiter}/createRateLimitedValue.d.cts +10 -4
- package/dist/{esm/rate-limiter → rate-limiter}/createRateLimitedValue.d.ts +10 -4
- package/dist/rate-limiter/createRateLimitedValue.js +102 -0
- package/dist/rate-limiter/createRateLimitedValue.js.map +1 -0
- package/dist/rate-limiter/createRateLimiter.cjs +95 -0
- package/dist/rate-limiter/createRateLimiter.cjs.map +1 -0
- package/dist/{cjs/rate-limiter → rate-limiter}/createRateLimiter.d.cts +23 -18
- package/dist/{esm/rate-limiter → rate-limiter}/createRateLimiter.d.ts +23 -18
- package/dist/rate-limiter/createRateLimiter.js +95 -0
- package/dist/rate-limiter/createRateLimiter.js.map +1 -0
- package/dist/rate-limiter/index.cjs +14 -0
- package/dist/rate-limiter/index.d.cts +5 -0
- package/dist/rate-limiter/index.d.ts +5 -0
- package/dist/{esm/rate-limiter → rate-limiter}/index.js +4 -7
- package/dist/throttler/createThrottledSignal.cjs +79 -0
- package/dist/throttler/createThrottledSignal.cjs.map +1 -0
- package/dist/{cjs/throttler → throttler}/createThrottledSignal.d.cts +10 -8
- package/dist/{esm/throttler → throttler}/createThrottledSignal.d.ts +10 -8
- package/dist/throttler/createThrottledSignal.js +79 -0
- package/dist/throttler/createThrottledSignal.js.map +1 -0
- package/dist/throttler/createThrottledValue.cjs +74 -0
- package/dist/throttler/createThrottledValue.cjs.map +1 -0
- package/dist/{cjs/throttler → throttler}/createThrottledValue.d.cts +10 -4
- package/dist/{esm/throttler → throttler}/createThrottledValue.d.ts +10 -4
- package/dist/throttler/createThrottledValue.js +74 -0
- package/dist/throttler/createThrottledValue.js.map +1 -0
- package/dist/throttler/createThrottler.cjs +97 -0
- package/dist/throttler/createThrottler.cjs.map +1 -0
- package/dist/{cjs/throttler → throttler}/createThrottler.d.cts +23 -18
- package/dist/{esm/throttler → throttler}/createThrottler.d.ts +23 -18
- package/dist/throttler/createThrottler.js +97 -0
- package/dist/throttler/createThrottler.js.map +1 -0
- package/dist/throttler/index.cjs +14 -0
- package/dist/throttler/index.d.cts +5 -0
- package/dist/throttler/index.d.ts +5 -0
- package/dist/{esm/throttler → throttler}/index.js +5 -8
- package/dist/types/index.cjs +9 -0
- package/dist/types/index.d.cts +1 -0
- package/dist/types/index.d.ts +1 -0
- package/dist/types/index.js +3 -0
- package/dist/utils/index.cjs +9 -0
- package/dist/utils/index.d.cts +1 -0
- package/dist/utils/index.d.ts +1 -0
- package/dist/utils/index.js +3 -0
- package/package.json +37 -106
- package/src/async-batcher/createAsyncBatcher.ts +4 -2
- package/src/async-queuer/createAsyncQueuer.ts +4 -2
- package/src/batcher/createBatcher.ts +4 -2
- package/src/debouncer/createDebouncer.ts +4 -2
- package/src/provider/index.ts +1 -0
- package/src/queuer/createQueuer.ts +4 -2
- package/src/rate-limiter/createRateLimiter.ts +4 -2
- package/src/throttler/createThrottler.ts +4 -2
- package/dist/cjs/async-batcher/createAsyncBatcher.cjs +0 -19
- package/dist/cjs/async-batcher/createAsyncBatcher.cjs.map +0 -1
- package/dist/cjs/async-batcher/index.cjs +0 -12
- package/dist/cjs/async-batcher/index.cjs.map +0 -1
- package/dist/cjs/async-batcher/index.d.cts +0 -2
- package/dist/cjs/async-debouncer/createAsyncDebouncer.cjs +0 -25
- package/dist/cjs/async-debouncer/createAsyncDebouncer.cjs.map +0 -1
- package/dist/cjs/async-debouncer/index.cjs +0 -12
- package/dist/cjs/async-debouncer/index.cjs.map +0 -1
- package/dist/cjs/async-debouncer/index.d.cts +0 -2
- package/dist/cjs/async-queuer/createAsyncQueuer.cjs +0 -19
- package/dist/cjs/async-queuer/createAsyncQueuer.cjs.map +0 -1
- package/dist/cjs/async-queuer/index.cjs +0 -12
- package/dist/cjs/async-queuer/index.cjs.map +0 -1
- package/dist/cjs/async-queuer/index.d.cts +0 -2
- package/dist/cjs/async-rate-limiter/createAsyncRateLimiter.cjs +0 -19
- package/dist/cjs/async-rate-limiter/createAsyncRateLimiter.cjs.map +0 -1
- package/dist/cjs/async-rate-limiter/index.cjs +0 -12
- package/dist/cjs/async-rate-limiter/index.cjs.map +0 -1
- package/dist/cjs/async-rate-limiter/index.d.cts +0 -2
- package/dist/cjs/async-throttler/createAsyncThrottler.cjs +0 -19
- package/dist/cjs/async-throttler/createAsyncThrottler.cjs.map +0 -1
- package/dist/cjs/async-throttler/index.cjs +0 -12
- package/dist/cjs/async-throttler/index.cjs.map +0 -1
- package/dist/cjs/async-throttler/index.d.cts +0 -2
- package/dist/cjs/batcher/createBatcher.cjs +0 -19
- package/dist/cjs/batcher/createBatcher.cjs.map +0 -1
- package/dist/cjs/batcher/index.cjs +0 -12
- package/dist/cjs/batcher/index.cjs.map +0 -1
- package/dist/cjs/batcher/index.d.cts +0 -2
- package/dist/cjs/debouncer/createDebouncedSignal.cjs +0 -11
- package/dist/cjs/debouncer/createDebouncedSignal.cjs.map +0 -1
- package/dist/cjs/debouncer/createDebouncedValue.cjs +0 -17
- package/dist/cjs/debouncer/createDebouncedValue.cjs.map +0 -1
- package/dist/cjs/debouncer/createDebouncer.cjs +0 -25
- package/dist/cjs/debouncer/createDebouncer.cjs.map +0 -1
- package/dist/cjs/debouncer/index.cjs +0 -16
- package/dist/cjs/debouncer/index.cjs.map +0 -1
- package/dist/cjs/debouncer/index.d.cts +0 -4
- package/dist/cjs/index.cjs +0 -48
- package/dist/cjs/index.cjs.map +0 -1
- package/dist/cjs/index.d.cts +0 -22
- package/dist/cjs/provider/PacerProvider.cjs +0 -28
- package/dist/cjs/provider/PacerProvider.cjs.map +0 -1
- package/dist/cjs/provider/PacerProvider.d.cts +0 -25
- package/dist/cjs/queuer/createQueuedSignal.cjs +0 -9
- package/dist/cjs/queuer/createQueuedSignal.cjs.map +0 -1
- package/dist/cjs/queuer/createQueuer.cjs +0 -19
- package/dist/cjs/queuer/createQueuer.cjs.map +0 -1
- package/dist/cjs/queuer/index.cjs +0 -14
- package/dist/cjs/queuer/index.cjs.map +0 -1
- package/dist/cjs/queuer/index.d.cts +0 -3
- package/dist/cjs/rate-limiter/createRateLimitedSignal.cjs +0 -19
- package/dist/cjs/rate-limiter/createRateLimitedSignal.cjs.map +0 -1
- package/dist/cjs/rate-limiter/createRateLimitedValue.cjs +0 -13
- package/dist/cjs/rate-limiter/createRateLimitedValue.cjs.map +0 -1
- package/dist/cjs/rate-limiter/createRateLimiter.cjs +0 -19
- package/dist/cjs/rate-limiter/createRateLimiter.cjs.map +0 -1
- package/dist/cjs/rate-limiter/index.cjs +0 -16
- package/dist/cjs/rate-limiter/index.cjs.map +0 -1
- package/dist/cjs/rate-limiter/index.d.cts +0 -4
- package/dist/cjs/throttler/createThrottledSignal.cjs +0 -11
- package/dist/cjs/throttler/createThrottledSignal.cjs.map +0 -1
- package/dist/cjs/throttler/createThrottledValue.cjs +0 -17
- package/dist/cjs/throttler/createThrottledValue.cjs.map +0 -1
- package/dist/cjs/throttler/createThrottler.cjs +0 -25
- package/dist/cjs/throttler/createThrottler.cjs.map +0 -1
- package/dist/cjs/throttler/index.cjs +0 -16
- package/dist/cjs/throttler/index.cjs.map +0 -1
- package/dist/cjs/throttler/index.d.cts +0 -4
- package/dist/cjs/types/index.cjs +0 -10
- package/dist/cjs/types/index.cjs.map +0 -1
- package/dist/cjs/types/index.d.cts +0 -1
- package/dist/cjs/utils/index.cjs +0 -10
- package/dist/cjs/utils/index.cjs.map +0 -1
- package/dist/cjs/utils/index.d.cts +0 -1
- package/dist/esm/async-batcher/createAsyncBatcher.js +0 -19
- package/dist/esm/async-batcher/createAsyncBatcher.js.map +0 -1
- package/dist/esm/async-batcher/index.d.ts +0 -2
- package/dist/esm/async-batcher/index.js +0 -6
- package/dist/esm/async-batcher/index.js.map +0 -1
- package/dist/esm/async-debouncer/createAsyncDebouncer.js +0 -25
- package/dist/esm/async-debouncer/createAsyncDebouncer.js.map +0 -1
- package/dist/esm/async-debouncer/index.d.ts +0 -2
- package/dist/esm/async-debouncer/index.js +0 -6
- package/dist/esm/async-debouncer/index.js.map +0 -1
- package/dist/esm/async-queuer/createAsyncQueuer.js +0 -19
- package/dist/esm/async-queuer/createAsyncQueuer.js.map +0 -1
- package/dist/esm/async-queuer/index.d.ts +0 -2
- package/dist/esm/async-queuer/index.js +0 -6
- package/dist/esm/async-queuer/index.js.map +0 -1
- package/dist/esm/async-rate-limiter/createAsyncRateLimiter.js +0 -19
- package/dist/esm/async-rate-limiter/createAsyncRateLimiter.js.map +0 -1
- package/dist/esm/async-rate-limiter/index.d.ts +0 -2
- package/dist/esm/async-rate-limiter/index.js +0 -6
- package/dist/esm/async-rate-limiter/index.js.map +0 -1
- package/dist/esm/async-throttler/createAsyncThrottler.js +0 -19
- package/dist/esm/async-throttler/createAsyncThrottler.js.map +0 -1
- package/dist/esm/async-throttler/index.d.ts +0 -2
- package/dist/esm/async-throttler/index.js +0 -6
- package/dist/esm/async-throttler/index.js.map +0 -1
- package/dist/esm/batcher/createBatcher.js +0 -19
- package/dist/esm/batcher/createBatcher.js.map +0 -1
- package/dist/esm/batcher/index.d.ts +0 -2
- package/dist/esm/batcher/index.js +0 -6
- package/dist/esm/batcher/index.js.map +0 -1
- package/dist/esm/debouncer/createDebouncedSignal.js +0 -11
- package/dist/esm/debouncer/createDebouncedSignal.js.map +0 -1
- package/dist/esm/debouncer/createDebouncedValue.js +0 -17
- package/dist/esm/debouncer/createDebouncedValue.js.map +0 -1
- package/dist/esm/debouncer/createDebouncer.js +0 -25
- package/dist/esm/debouncer/createDebouncer.js.map +0 -1
- package/dist/esm/debouncer/index.d.ts +0 -4
- package/dist/esm/debouncer/index.js.map +0 -1
- package/dist/esm/index.d.ts +0 -22
- package/dist/esm/index.js.map +0 -1
- package/dist/esm/provider/PacerProvider.d.ts +0 -25
- package/dist/esm/provider/PacerProvider.js +0 -28
- package/dist/esm/provider/PacerProvider.js.map +0 -1
- package/dist/esm/queuer/createQueuedSignal.js +0 -9
- package/dist/esm/queuer/createQueuedSignal.js.map +0 -1
- package/dist/esm/queuer/createQueuer.js +0 -19
- package/dist/esm/queuer/createQueuer.js.map +0 -1
- package/dist/esm/queuer/index.d.ts +0 -3
- package/dist/esm/queuer/index.js +0 -8
- package/dist/esm/queuer/index.js.map +0 -1
- package/dist/esm/rate-limiter/createRateLimitedSignal.js +0 -19
- package/dist/esm/rate-limiter/createRateLimitedSignal.js.map +0 -1
- package/dist/esm/rate-limiter/createRateLimitedValue.js +0 -13
- package/dist/esm/rate-limiter/createRateLimitedValue.js.map +0 -1
- package/dist/esm/rate-limiter/createRateLimiter.js +0 -19
- package/dist/esm/rate-limiter/createRateLimiter.js.map +0 -1
- package/dist/esm/rate-limiter/index.d.ts +0 -4
- package/dist/esm/rate-limiter/index.js.map +0 -1
- package/dist/esm/throttler/createThrottledSignal.js +0 -11
- package/dist/esm/throttler/createThrottledSignal.js.map +0 -1
- package/dist/esm/throttler/createThrottledValue.js +0 -17
- package/dist/esm/throttler/createThrottledValue.js.map +0 -1
- package/dist/esm/throttler/createThrottler.js +0 -25
- package/dist/esm/throttler/createThrottler.js.map +0 -1
- package/dist/esm/throttler/index.d.ts +0 -4
- package/dist/esm/throttler/index.js.map +0 -1
- package/dist/esm/types/index.d.ts +0 -1
- package/dist/esm/types/index.js +0 -2
- package/dist/esm/types/index.js.map +0 -1
- package/dist/esm/utils/index.d.ts +0 -1
- package/dist/esm/utils/index.js +0 -2
- package/dist/esm/utils/index.js.map +0 -1
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
|
|
2
|
+
import { createEffect, onCleanup } from "solid-js";
|
|
3
|
+
import { useStore } from "@tanstack/solid-store";
|
|
4
|
+
import { Debouncer } from "@tanstack/pacer/debouncer";
|
|
5
|
+
|
|
6
|
+
//#region src/debouncer/createDebouncer.ts
|
|
7
|
+
/**
|
|
8
|
+
* A Solid hook that creates and manages a Debouncer instance.
|
|
9
|
+
*
|
|
10
|
+
* This is a lower-level hook that provides direct access to the Debouncer's functionality without
|
|
11
|
+
* any built-in state management. This allows you to integrate it with any state management solution
|
|
12
|
+
* you prefer (createSignal, Redux, Zustand, etc.).
|
|
13
|
+
*
|
|
14
|
+
* This hook provides debouncing functionality to limit how often a function can be called,
|
|
15
|
+
* waiting for a specified delay before executing the latest call. This is useful for handling
|
|
16
|
+
* frequent events like window resizing, scroll events, or real-time search inputs.
|
|
17
|
+
*
|
|
18
|
+
* The debouncer will only execute the function after the specified wait time has elapsed
|
|
19
|
+
* since the last call. If the function is called again before the wait time expires, the
|
|
20
|
+
* timer resets and starts waiting again.
|
|
21
|
+
*
|
|
22
|
+
* ## State Management and Selector
|
|
23
|
+
*
|
|
24
|
+
* The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
|
|
25
|
+
* to specify which state changes will trigger a re-render, optimizing performance by preventing
|
|
26
|
+
* unnecessary re-renders when irrelevant state changes occur.
|
|
27
|
+
*
|
|
28
|
+
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
29
|
+
* tracking by providing a selector function. This prevents unnecessary re-renders and gives you
|
|
30
|
+
* full control over when your component updates. Only when you provide a selector will the
|
|
31
|
+
* component re-render when the selected state values change.
|
|
32
|
+
*
|
|
33
|
+
* Available state properties:
|
|
34
|
+
* - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
|
|
35
|
+
* - `executionCount`: Number of function executions that have been completed
|
|
36
|
+
* - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
|
|
37
|
+
* - `lastArgs`: The arguments from the most recent call to maybeExecute
|
|
38
|
+
* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```tsx
|
|
42
|
+
* // Default behavior - no reactive state subscriptions
|
|
43
|
+
* const debouncer = createDebouncer(
|
|
44
|
+
* (query: string) => fetchSearchResults(query),
|
|
45
|
+
* { wait: 500 }
|
|
46
|
+
* );
|
|
47
|
+
*
|
|
48
|
+
* // Opt-in to re-render when isPending changes (optimized for loading states)
|
|
49
|
+
* const debouncer = createDebouncer(
|
|
50
|
+
* (query: string) => fetchSearchResults(query),
|
|
51
|
+
* { wait: 500 },
|
|
52
|
+
* (state) => ({ isPending: state.isPending })
|
|
53
|
+
* );
|
|
54
|
+
*
|
|
55
|
+
* // Opt-in to re-render when executionCount changes (optimized for tracking execution)
|
|
56
|
+
* const debouncer = createDebouncer(
|
|
57
|
+
* (query: string) => fetchSearchResults(query),
|
|
58
|
+
* { wait: 500 },
|
|
59
|
+
* (state) => ({ executionCount: state.executionCount })
|
|
60
|
+
* );
|
|
61
|
+
*
|
|
62
|
+
* // Multiple state properties - re-render when any of these change
|
|
63
|
+
* const debouncer = createDebouncer(
|
|
64
|
+
* (query: string) => fetchSearchResults(query),
|
|
65
|
+
* { wait: 500 },
|
|
66
|
+
* (state) => ({
|
|
67
|
+
* isPending: state.isPending,
|
|
68
|
+
* executionCount: state.executionCount,
|
|
69
|
+
* status: state.status
|
|
70
|
+
* })
|
|
71
|
+
* );
|
|
72
|
+
*
|
|
73
|
+
* // In an event handler
|
|
74
|
+
* const handleChange = (e) => {
|
|
75
|
+
* debouncer.maybeExecute(e.target.value);
|
|
76
|
+
* };
|
|
77
|
+
*
|
|
78
|
+
* // Access the selected state (will be empty object {} unless selector provided)
|
|
79
|
+
* const { isPending } = debouncer.state();
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
function createDebouncer(fn, options, selector = () => ({})) {
|
|
83
|
+
const asyncDebouncer = new Debouncer(fn, {
|
|
84
|
+
...useDefaultPacerOptions().debouncer,
|
|
85
|
+
...options
|
|
86
|
+
});
|
|
87
|
+
const state = useStore(asyncDebouncer.store, selector);
|
|
88
|
+
createEffect(() => {
|
|
89
|
+
onCleanup(() => {
|
|
90
|
+
asyncDebouncer.cancel();
|
|
91
|
+
});
|
|
92
|
+
});
|
|
93
|
+
return {
|
|
94
|
+
...asyncDebouncer,
|
|
95
|
+
state
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
//#endregion
|
|
100
|
+
export { createDebouncer };
|
|
101
|
+
//# sourceMappingURL=createDebouncer.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createDebouncer.js","names":[],"sources":["../../src/debouncer/createDebouncer.ts"],"sourcesContent":["import { Debouncer } from '@tanstack/pacer/debouncer'\nimport { createEffect, onCleanup } from 'solid-js'\nimport { useStore } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n DebouncerOptions,\n DebouncerState,\n} from '@tanstack/pacer/debouncer'\n\nexport interface SolidDebouncer<\n TFn extends AnyFunction,\n TSelected = {},\n> extends Omit<Debouncer<TFn>, 'store'> {\n /**\n * Reactive state that will be updated when the debouncer state changes\n *\n * Use this instead of `debouncer.store.state`\n */\n readonly state: Accessor<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, as it has not been wrapped in a `useStore` hook internally.\n * Although, you can make the state reactive by using the `useStore` in your own usage.\n */\n readonly store: Store<Readonly<DebouncerState<TFn>>>\n}\n\n/**\n * A Solid hook that creates and manages a Debouncer instance.\n *\n * This is a lower-level hook that provides direct access to the Debouncer's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (createSignal, Redux, Zustand, etc.).\n *\n * This hook 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 hook uses TanStack Store for reactive state management. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * unnecessary re-renders 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 re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\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 * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const debouncer = createDebouncer(\n * (query: string) => fetchSearchResults(query),\n * { wait: 500 }\n * );\n *\n * // Opt-in to re-render when isPending changes (optimized for loading states)\n * const debouncer = createDebouncer(\n * (query: string) => fetchSearchResults(query),\n * { wait: 500 },\n * (state) => ({ isPending: state.isPending })\n * );\n *\n * // Opt-in to re-render when executionCount changes (optimized for tracking execution)\n * const debouncer = createDebouncer(\n * (query: string) => fetchSearchResults(query),\n * { wait: 500 },\n * (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Multiple state properties - re-render when any of these change\n * const debouncer = createDebouncer(\n * (query: string) => fetchSearchResults(query),\n * { wait: 500 },\n * (state) => ({\n * isPending: state.isPending,\n * executionCount: state.executionCount,\n * status: state.status\n * })\n * );\n *\n * // In an event handler\n * const handleChange = (e) => {\n * debouncer.maybeExecute(e.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 createDebouncer<TFn extends AnyFunction, TSelected = {}>(\n fn: TFn,\n options: DebouncerOptions<TFn>,\n selector: (state: DebouncerState<TFn>) => TSelected = () => ({}) as TSelected,\n): SolidDebouncer<TFn, TSelected> {\n const mergedOptions = {\n ...useDefaultPacerOptions().debouncer,\n ...options,\n } as DebouncerOptions<TFn>\n\n const asyncDebouncer = new Debouncer<TFn>(fn, mergedOptions)\n\n const state = useStore(asyncDebouncer.store, selector)\n\n createEffect(() => {\n onCleanup(() => {\n asyncDebouncer.cancel()\n })\n })\n\n return {\n ...asyncDebouncer,\n state,\n } as SolidDebouncer<TFn, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyGA,SAAgB,gBACd,IACA,SACA,kBAA6D,EAAE,GAC/B;CAMhC,MAAM,iBAAiB,IAAI,UAAe,IALpB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ,CAE2D;CAE5D,MAAM,QAAQ,SAAS,eAAe,OAAO,SAAS;AAEtD,oBAAmB;AACjB,kBAAgB;AACd,kBAAe,QAAQ;IACvB;GACF;AAEF,QAAO;EACL,GAAG;EACH;EACD"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
const require_createDebouncer = require('./createDebouncer.cjs');
|
|
2
|
+
const require_createDebouncedSignal = require('./createDebouncedSignal.cjs');
|
|
3
|
+
const require_createDebouncedValue = require('./createDebouncedValue.cjs');
|
|
4
|
+
|
|
5
|
+
exports.createDebouncedSignal = require_createDebouncedSignal.createDebouncedSignal;
|
|
6
|
+
exports.createDebouncedValue = require_createDebouncedValue.createDebouncedValue;
|
|
7
|
+
exports.createDebouncer = require_createDebouncer.createDebouncer;
|
|
8
|
+
var __tanstack_pacer_debouncer = require("@tanstack/pacer/debouncer");
|
|
9
|
+
Object.keys(__tanstack_pacer_debouncer).forEach(function (k) {
|
|
10
|
+
if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
|
|
11
|
+
enumerable: true,
|
|
12
|
+
get: function () { return __tanstack_pacer_debouncer[k]; }
|
|
13
|
+
});
|
|
14
|
+
});
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { SolidDebouncer, createDebouncer } from "./createDebouncer.cjs";
|
|
2
|
+
import { createDebouncedSignal } from "./createDebouncedSignal.cjs";
|
|
3
|
+
import { createDebouncedValue } from "./createDebouncedValue.cjs";
|
|
4
|
+
export * from "@tanstack/pacer/debouncer";
|
|
5
|
+
export { SolidDebouncer, createDebouncedSignal, createDebouncedValue, createDebouncer };
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { SolidDebouncer, createDebouncer } from "./createDebouncer.js";
|
|
2
|
+
import { createDebouncedSignal } from "./createDebouncedSignal.js";
|
|
3
|
+
import { createDebouncedValue } from "./createDebouncedValue.js";
|
|
4
|
+
export * from "@tanstack/pacer/debouncer";
|
|
5
|
+
export { SolidDebouncer, createDebouncedSignal, createDebouncedValue, createDebouncer };
|
|
@@ -1,10 +1,7 @@
|
|
|
1
|
-
|
|
1
|
+
import { createDebouncer } from "./createDebouncer.js";
|
|
2
2
|
import { createDebouncedSignal } from "./createDebouncedSignal.js";
|
|
3
3
|
import { createDebouncedValue } from "./createDebouncedValue.js";
|
|
4
|
-
|
|
5
|
-
export
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
createDebouncer
|
|
9
|
-
};
|
|
10
|
-
//# sourceMappingURL=index.js.map
|
|
4
|
+
|
|
5
|
+
export * from "@tanstack/pacer/debouncer"
|
|
6
|
+
|
|
7
|
+
export { createDebouncedSignal, createDebouncedValue, createDebouncer };
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
const require_PacerProvider = require('./provider/PacerProvider.cjs');
|
|
2
|
+
const require_createAsyncBatcher = require('./async-batcher/createAsyncBatcher.cjs');
|
|
3
|
+
const require_createAsyncDebouncer = require('./async-debouncer/createAsyncDebouncer.cjs');
|
|
4
|
+
const require_createAsyncQueuer = require('./async-queuer/createAsyncQueuer.cjs');
|
|
5
|
+
const require_createAsyncRateLimiter = require('./async-rate-limiter/createAsyncRateLimiter.cjs');
|
|
6
|
+
const require_createAsyncThrottler = require('./async-throttler/createAsyncThrottler.cjs');
|
|
7
|
+
const require_createBatcher = require('./batcher/createBatcher.cjs');
|
|
8
|
+
const require_createDebouncer = require('./debouncer/createDebouncer.cjs');
|
|
9
|
+
const require_createDebouncedSignal = require('./debouncer/createDebouncedSignal.cjs');
|
|
10
|
+
const require_createDebouncedValue = require('./debouncer/createDebouncedValue.cjs');
|
|
11
|
+
const require_createQueuer = require('./queuer/createQueuer.cjs');
|
|
12
|
+
const require_createQueuedSignal = require('./queuer/createQueuedSignal.cjs');
|
|
13
|
+
const require_createRateLimiter = require('./rate-limiter/createRateLimiter.cjs');
|
|
14
|
+
const require_createRateLimitedSignal = require('./rate-limiter/createRateLimitedSignal.cjs');
|
|
15
|
+
const require_createRateLimitedValue = require('./rate-limiter/createRateLimitedValue.cjs');
|
|
16
|
+
const require_createThrottler = require('./throttler/createThrottler.cjs');
|
|
17
|
+
const require_createThrottledSignal = require('./throttler/createThrottledSignal.cjs');
|
|
18
|
+
const require_createThrottledValue = require('./throttler/createThrottledValue.cjs');
|
|
19
|
+
|
|
20
|
+
exports.PacerProvider = require_PacerProvider.PacerProvider;
|
|
21
|
+
exports.createAsyncBatcher = require_createAsyncBatcher.createAsyncBatcher;
|
|
22
|
+
exports.createAsyncDebouncer = require_createAsyncDebouncer.createAsyncDebouncer;
|
|
23
|
+
exports.createAsyncQueuer = require_createAsyncQueuer.createAsyncQueuer;
|
|
24
|
+
exports.createAsyncRateLimiter = require_createAsyncRateLimiter.createAsyncRateLimiter;
|
|
25
|
+
exports.createAsyncThrottler = require_createAsyncThrottler.createAsyncThrottler;
|
|
26
|
+
exports.createBatcher = require_createBatcher.createBatcher;
|
|
27
|
+
exports.createDebouncedSignal = require_createDebouncedSignal.createDebouncedSignal;
|
|
28
|
+
exports.createDebouncedValue = require_createDebouncedValue.createDebouncedValue;
|
|
29
|
+
exports.createDebouncer = require_createDebouncer.createDebouncer;
|
|
30
|
+
exports.createQueuedSignal = require_createQueuedSignal.createQueuedSignal;
|
|
31
|
+
exports.createQueuer = require_createQueuer.createQueuer;
|
|
32
|
+
exports.createRateLimitedSignal = require_createRateLimitedSignal.createRateLimitedSignal;
|
|
33
|
+
exports.createRateLimitedValue = require_createRateLimitedValue.createRateLimitedValue;
|
|
34
|
+
exports.createRateLimiter = require_createRateLimiter.createRateLimiter;
|
|
35
|
+
exports.createThrottledSignal = require_createThrottledSignal.createThrottledSignal;
|
|
36
|
+
exports.createThrottledValue = require_createThrottledValue.createThrottledValue;
|
|
37
|
+
exports.createThrottler = require_createThrottler.createThrottler;
|
|
38
|
+
exports.useDefaultPacerOptions = require_PacerProvider.useDefaultPacerOptions;
|
|
39
|
+
exports.usePacerContext = require_PacerProvider.usePacerContext;
|
|
40
|
+
var __tanstack_pacer = require("@tanstack/pacer");
|
|
41
|
+
Object.keys(__tanstack_pacer).forEach(function (k) {
|
|
42
|
+
if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
|
|
43
|
+
enumerable: true,
|
|
44
|
+
get: function () { return __tanstack_pacer[k]; }
|
|
45
|
+
});
|
|
46
|
+
});
|
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { SolidAsyncBatcher, createAsyncBatcher } from "./async-batcher/createAsyncBatcher.cjs";
|
|
2
|
+
import { SolidAsyncDebouncer, createAsyncDebouncer } from "./async-debouncer/createAsyncDebouncer.cjs";
|
|
3
|
+
import { SolidAsyncQueuer, createAsyncQueuer } from "./async-queuer/createAsyncQueuer.cjs";
|
|
4
|
+
import { SolidAsyncRateLimiter, createAsyncRateLimiter } from "./async-rate-limiter/createAsyncRateLimiter.cjs";
|
|
5
|
+
import { SolidAsyncThrottler, createAsyncThrottler } from "./async-throttler/createAsyncThrottler.cjs";
|
|
6
|
+
import { SolidBatcher, createBatcher } from "./batcher/createBatcher.cjs";
|
|
7
|
+
import { SolidDebouncer, createDebouncer } from "./debouncer/createDebouncer.cjs";
|
|
8
|
+
import { createDebouncedSignal } from "./debouncer/createDebouncedSignal.cjs";
|
|
9
|
+
import { createDebouncedValue } from "./debouncer/createDebouncedValue.cjs";
|
|
10
|
+
import { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext } from "./provider/PacerProvider.cjs";
|
|
11
|
+
import { SolidQueuer, createQueuer } from "./queuer/createQueuer.cjs";
|
|
12
|
+
import { createQueuedSignal } from "./queuer/createQueuedSignal.cjs";
|
|
13
|
+
import { SolidRateLimiter, createRateLimiter } from "./rate-limiter/createRateLimiter.cjs";
|
|
14
|
+
import { createRateLimitedSignal } from "./rate-limiter/createRateLimitedSignal.cjs";
|
|
15
|
+
import { createRateLimitedValue } from "./rate-limiter/createRateLimitedValue.cjs";
|
|
16
|
+
import { SolidThrottler, createThrottler } from "./throttler/createThrottler.cjs";
|
|
17
|
+
import { createThrottledSignal } from "./throttler/createThrottledSignal.cjs";
|
|
18
|
+
import { createThrottledValue } from "./throttler/createThrottledValue.cjs";
|
|
19
|
+
export * from "@tanstack/pacer";
|
|
20
|
+
export { PacerProvider, PacerProviderOptions, PacerProviderProps, SolidAsyncBatcher, SolidAsyncDebouncer, SolidAsyncQueuer, SolidAsyncRateLimiter, SolidAsyncThrottler, SolidBatcher, SolidDebouncer, SolidQueuer, SolidRateLimiter, SolidThrottler, createAsyncBatcher, createAsyncDebouncer, createAsyncQueuer, createAsyncRateLimiter, createAsyncThrottler, createBatcher, createDebouncedSignal, createDebouncedValue, createDebouncer, createQueuedSignal, createQueuer, createRateLimitedSignal, createRateLimitedValue, createRateLimiter, createThrottledSignal, createThrottledValue, createThrottler, useDefaultPacerOptions, usePacerContext };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { SolidAsyncBatcher, createAsyncBatcher } from "./async-batcher/createAsyncBatcher.js";
|
|
2
|
+
import { SolidAsyncDebouncer, createAsyncDebouncer } from "./async-debouncer/createAsyncDebouncer.js";
|
|
3
|
+
import { SolidAsyncQueuer, createAsyncQueuer } from "./async-queuer/createAsyncQueuer.js";
|
|
4
|
+
import { SolidAsyncRateLimiter, createAsyncRateLimiter } from "./async-rate-limiter/createAsyncRateLimiter.js";
|
|
5
|
+
import { SolidAsyncThrottler, createAsyncThrottler } from "./async-throttler/createAsyncThrottler.js";
|
|
6
|
+
import { SolidBatcher, createBatcher } from "./batcher/createBatcher.js";
|
|
7
|
+
import { SolidDebouncer, createDebouncer } from "./debouncer/createDebouncer.js";
|
|
8
|
+
import { createDebouncedSignal } from "./debouncer/createDebouncedSignal.js";
|
|
9
|
+
import { createDebouncedValue } from "./debouncer/createDebouncedValue.js";
|
|
10
|
+
import { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext } from "./provider/PacerProvider.js";
|
|
11
|
+
import { SolidQueuer, createQueuer } from "./queuer/createQueuer.js";
|
|
12
|
+
import { createQueuedSignal } from "./queuer/createQueuedSignal.js";
|
|
13
|
+
import { SolidRateLimiter, createRateLimiter } from "./rate-limiter/createRateLimiter.js";
|
|
14
|
+
import { createRateLimitedSignal } from "./rate-limiter/createRateLimitedSignal.js";
|
|
15
|
+
import { createRateLimitedValue } from "./rate-limiter/createRateLimitedValue.js";
|
|
16
|
+
import { SolidThrottler, createThrottler } from "./throttler/createThrottler.js";
|
|
17
|
+
import { createThrottledSignal } from "./throttler/createThrottledSignal.js";
|
|
18
|
+
import { createThrottledValue } from "./throttler/createThrottledValue.js";
|
|
19
|
+
export * from "@tanstack/pacer";
|
|
20
|
+
export { PacerProvider, PacerProviderOptions, PacerProviderProps, SolidAsyncBatcher, SolidAsyncDebouncer, SolidAsyncQueuer, SolidAsyncRateLimiter, SolidAsyncThrottler, SolidBatcher, SolidDebouncer, SolidQueuer, SolidRateLimiter, SolidThrottler, createAsyncBatcher, createAsyncDebouncer, createAsyncQueuer, createAsyncRateLimiter, createAsyncThrottler, createBatcher, createDebouncedSignal, createDebouncedValue, createDebouncer, createQueuedSignal, createQueuer, createRateLimitedSignal, createRateLimitedValue, createRateLimiter, createThrottledSignal, createThrottledValue, createThrottler, useDefaultPacerOptions, usePacerContext };
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
export * from "@tanstack/pacer";
|
|
2
1
|
import { PacerProvider, useDefaultPacerOptions, usePacerContext } from "./provider/PacerProvider.js";
|
|
3
2
|
import { createAsyncBatcher } from "./async-batcher/createAsyncBatcher.js";
|
|
4
3
|
import { createAsyncDebouncer } from "./async-debouncer/createAsyncDebouncer.js";
|
|
@@ -6,37 +5,18 @@ import { createAsyncQueuer } from "./async-queuer/createAsyncQueuer.js";
|
|
|
6
5
|
import { createAsyncRateLimiter } from "./async-rate-limiter/createAsyncRateLimiter.js";
|
|
7
6
|
import { createAsyncThrottler } from "./async-throttler/createAsyncThrottler.js";
|
|
8
7
|
import { createBatcher } from "./batcher/createBatcher.js";
|
|
8
|
+
import { createDebouncer } from "./debouncer/createDebouncer.js";
|
|
9
9
|
import { createDebouncedSignal } from "./debouncer/createDebouncedSignal.js";
|
|
10
10
|
import { createDebouncedValue } from "./debouncer/createDebouncedValue.js";
|
|
11
|
-
import { createDebouncer } from "./debouncer/createDebouncer.js";
|
|
12
11
|
import { createQueuer } from "./queuer/createQueuer.js";
|
|
13
12
|
import { createQueuedSignal } from "./queuer/createQueuedSignal.js";
|
|
14
13
|
import { createRateLimiter } from "./rate-limiter/createRateLimiter.js";
|
|
15
14
|
import { createRateLimitedSignal } from "./rate-limiter/createRateLimitedSignal.js";
|
|
16
15
|
import { createRateLimitedValue } from "./rate-limiter/createRateLimitedValue.js";
|
|
16
|
+
import { createThrottler } from "./throttler/createThrottler.js";
|
|
17
17
|
import { createThrottledSignal } from "./throttler/createThrottledSignal.js";
|
|
18
18
|
import { createThrottledValue } from "./throttler/createThrottledValue.js";
|
|
19
|
-
|
|
20
|
-
export
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
createAsyncDebouncer,
|
|
24
|
-
createAsyncQueuer,
|
|
25
|
-
createAsyncRateLimiter,
|
|
26
|
-
createAsyncThrottler,
|
|
27
|
-
createBatcher,
|
|
28
|
-
createDebouncedSignal,
|
|
29
|
-
createDebouncedValue,
|
|
30
|
-
createDebouncer,
|
|
31
|
-
createQueuedSignal,
|
|
32
|
-
createQueuer,
|
|
33
|
-
createRateLimitedSignal,
|
|
34
|
-
createRateLimitedValue,
|
|
35
|
-
createRateLimiter,
|
|
36
|
-
createThrottledSignal,
|
|
37
|
-
createThrottledValue,
|
|
38
|
-
createThrottler,
|
|
39
|
-
useDefaultPacerOptions,
|
|
40
|
-
usePacerContext
|
|
41
|
-
};
|
|
42
|
-
//# sourceMappingURL=index.js.map
|
|
19
|
+
|
|
20
|
+
export * from "@tanstack/pacer"
|
|
21
|
+
|
|
22
|
+
export { PacerProvider, createAsyncBatcher, createAsyncDebouncer, createAsyncQueuer, createAsyncRateLimiter, createAsyncThrottler, createBatcher, createDebouncedSignal, createDebouncedValue, createDebouncer, createQueuedSignal, createQueuer, createRateLimitedSignal, createRateLimitedValue, createRateLimiter, createThrottledSignal, createThrottledValue, createThrottler, useDefaultPacerOptions, usePacerContext };
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
let solid_js_web = require("solid-js/web");
|
|
2
|
+
let solid_js = require("solid-js");
|
|
3
|
+
|
|
4
|
+
//#region src/provider/PacerProvider.tsx
|
|
5
|
+
const PacerContext = (0, solid_js.createContext)(null);
|
|
6
|
+
const DEFAULT_OPTIONS = {};
|
|
7
|
+
function PacerProvider(props) {
|
|
8
|
+
const contextValue = { defaultOptions: props.defaultOptions ?? DEFAULT_OPTIONS };
|
|
9
|
+
return (0, solid_js_web.createComponent)(PacerContext.Provider, {
|
|
10
|
+
value: contextValue,
|
|
11
|
+
get children() {
|
|
12
|
+
return props.children;
|
|
13
|
+
}
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
function usePacerContext() {
|
|
17
|
+
return (0, solid_js.useContext)(PacerContext);
|
|
18
|
+
}
|
|
19
|
+
function useDefaultPacerOptions() {
|
|
20
|
+
return (0, solid_js.useContext)(PacerContext)?.defaultOptions ?? {};
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
//#endregion
|
|
24
|
+
exports.PacerProvider = PacerProvider;
|
|
25
|
+
exports.useDefaultPacerOptions = useDefaultPacerOptions;
|
|
26
|
+
exports.usePacerContext = usePacerContext;
|
|
27
|
+
//# sourceMappingURL=PacerProvider.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PacerProvider.cjs","names":["createContext","useContext","JSX","AnyAsyncFunction","AnyFunction","AsyncBatcherOptions","AsyncDebouncerOptions","AsyncQueuerOptions","AsyncRateLimiterOptions","AsyncThrottlerOptions","BatcherOptions","DebouncerOptions","QueuerOptions","RateLimiterOptions","ThrottlerOptions","PacerProviderOptions","asyncBatcher","Partial","asyncDebouncer","asyncQueuer","asyncRateLimiter","asyncThrottler","batcher","debouncer","queuer","rateLimiter","throttler","PacerContextValue","defaultOptions","PacerContext","PacerProviderProps","children","Element","DEFAULT_OPTIONS","PacerProvider","props","contextValue","_$createComponent","Provider","value","usePacerContext","useDefaultPacerOptions","context"],"sources":["../../src/provider/PacerProvider.tsx"],"sourcesContent":["import { createContext, useContext } from 'solid-js'\nimport type { JSX } from 'solid-js'\nimport type {\n AnyAsyncFunction,\n AnyFunction,\n AsyncBatcherOptions,\n AsyncDebouncerOptions,\n AsyncQueuerOptions,\n AsyncRateLimiterOptions,\n AsyncThrottlerOptions,\n BatcherOptions,\n DebouncerOptions,\n QueuerOptions,\n RateLimiterOptions,\n ThrottlerOptions,\n} from '@tanstack/pacer'\n\nexport interface PacerProviderOptions {\n asyncBatcher?: Partial<AsyncBatcherOptions<any>>\n asyncDebouncer?: Partial<AsyncDebouncerOptions<AnyAsyncFunction>>\n asyncQueuer?: Partial<AsyncQueuerOptions<any>>\n asyncRateLimiter?: Partial<AsyncRateLimiterOptions<AnyAsyncFunction>>\n asyncThrottler?: Partial<AsyncThrottlerOptions<AnyAsyncFunction>>\n batcher?: Partial<BatcherOptions<any>>\n debouncer?: Partial<DebouncerOptions<AnyFunction>>\n queuer?: Partial<QueuerOptions<any>>\n rateLimiter?: Partial<RateLimiterOptions<AnyFunction>>\n throttler?: Partial<ThrottlerOptions<AnyFunction>>\n}\n\ninterface PacerContextValue {\n defaultOptions: PacerProviderOptions\n}\n\nconst PacerContext = createContext<PacerContextValue | null>(null)\n\nexport interface PacerProviderProps {\n children: JSX.Element\n defaultOptions?: PacerProviderOptions\n}\n\nconst DEFAULT_OPTIONS: PacerProviderOptions = {}\n\nexport function PacerProvider(props: PacerProviderProps) {\n const contextValue: PacerContextValue = {\n defaultOptions: props.defaultOptions ?? DEFAULT_OPTIONS,\n }\n\n return (\n <PacerContext.Provider value={contextValue}>\n {props.children}\n </PacerContext.Provider>\n )\n}\n\nexport function usePacerContext() {\n return useContext(PacerContext)\n}\n\nexport function useDefaultPacerOptions() {\n const context = useContext(PacerContext)\n return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;;AAkCA,MAAM6B,2CAAuD,KAAK;AAOlE,MAAMI,kBAAwC,EAAE;AAEhD,SAAgBC,cAAcC,OAA2B;CACvD,MAAMC,eAAkC,EACtCR,gBAAgBO,MAAMP,kBAAkBK,iBACzC;AAED,0CACGJ,aAAaS,UAAQ;EAACC,OAAOH;EAAY,IAAAL,WAAA;AAAA,UACvCI,MAAMJ;;EAAQ,CAAA;;AAKrB,SAAgBS,kBAAkB;AAChC,iCAAkBX,aAAa;;AAGjC,SAAgBY,yBAAyB;AAEvC,iCAD2BZ,aAAa,EACxBD,kBAAkB,EAAE"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { JSX } from "solid-js";
|
|
2
|
+
import { AnyAsyncFunction, AnyFunction, AsyncBatcherOptions, AsyncDebouncerOptions, AsyncQueuerOptions, AsyncRateLimiterOptions, AsyncThrottlerOptions, BatcherOptions, DebouncerOptions, QueuerOptions, RateLimiterOptions, ThrottlerOptions } from "@tanstack/pacer";
|
|
3
|
+
|
|
4
|
+
//#region src/provider/PacerProvider.d.ts
|
|
5
|
+
interface PacerProviderOptions {
|
|
6
|
+
asyncBatcher?: Partial<AsyncBatcherOptions<any>>;
|
|
7
|
+
asyncDebouncer?: Partial<AsyncDebouncerOptions<AnyAsyncFunction>>;
|
|
8
|
+
asyncQueuer?: Partial<AsyncQueuerOptions<any>>;
|
|
9
|
+
asyncRateLimiter?: Partial<AsyncRateLimiterOptions<AnyAsyncFunction>>;
|
|
10
|
+
asyncThrottler?: Partial<AsyncThrottlerOptions<AnyAsyncFunction>>;
|
|
11
|
+
batcher?: Partial<BatcherOptions<any>>;
|
|
12
|
+
debouncer?: Partial<DebouncerOptions<AnyFunction>>;
|
|
13
|
+
queuer?: Partial<QueuerOptions<any>>;
|
|
14
|
+
rateLimiter?: Partial<RateLimiterOptions<AnyFunction>>;
|
|
15
|
+
throttler?: Partial<ThrottlerOptions<AnyFunction>>;
|
|
16
|
+
}
|
|
17
|
+
interface PacerContextValue {
|
|
18
|
+
defaultOptions: PacerProviderOptions;
|
|
19
|
+
}
|
|
20
|
+
interface PacerProviderProps {
|
|
21
|
+
children: JSX.Element;
|
|
22
|
+
defaultOptions?: PacerProviderOptions;
|
|
23
|
+
}
|
|
24
|
+
declare function PacerProvider(props: PacerProviderProps): JSX.Element;
|
|
25
|
+
declare function usePacerContext(): PacerContextValue | null;
|
|
26
|
+
declare function useDefaultPacerOptions(): PacerProviderOptions;
|
|
27
|
+
//#endregion
|
|
28
|
+
export { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext };
|
|
29
|
+
//# sourceMappingURL=PacerProvider.d.cts.map
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { AnyAsyncFunction, AnyFunction, AsyncBatcherOptions, AsyncDebouncerOptions, AsyncQueuerOptions, AsyncRateLimiterOptions, AsyncThrottlerOptions, BatcherOptions, DebouncerOptions, QueuerOptions, RateLimiterOptions, ThrottlerOptions } from "@tanstack/pacer";
|
|
2
|
+
import { JSX } from "solid-js";
|
|
3
|
+
|
|
4
|
+
//#region src/provider/PacerProvider.d.ts
|
|
5
|
+
interface PacerProviderOptions {
|
|
6
|
+
asyncBatcher?: Partial<AsyncBatcherOptions<any>>;
|
|
7
|
+
asyncDebouncer?: Partial<AsyncDebouncerOptions<AnyAsyncFunction>>;
|
|
8
|
+
asyncQueuer?: Partial<AsyncQueuerOptions<any>>;
|
|
9
|
+
asyncRateLimiter?: Partial<AsyncRateLimiterOptions<AnyAsyncFunction>>;
|
|
10
|
+
asyncThrottler?: Partial<AsyncThrottlerOptions<AnyAsyncFunction>>;
|
|
11
|
+
batcher?: Partial<BatcherOptions<any>>;
|
|
12
|
+
debouncer?: Partial<DebouncerOptions<AnyFunction>>;
|
|
13
|
+
queuer?: Partial<QueuerOptions<any>>;
|
|
14
|
+
rateLimiter?: Partial<RateLimiterOptions<AnyFunction>>;
|
|
15
|
+
throttler?: Partial<ThrottlerOptions<AnyFunction>>;
|
|
16
|
+
}
|
|
17
|
+
interface PacerContextValue {
|
|
18
|
+
defaultOptions: PacerProviderOptions;
|
|
19
|
+
}
|
|
20
|
+
interface PacerProviderProps {
|
|
21
|
+
children: JSX.Element;
|
|
22
|
+
defaultOptions?: PacerProviderOptions;
|
|
23
|
+
}
|
|
24
|
+
declare function PacerProvider(props: PacerProviderProps): JSX.Element;
|
|
25
|
+
declare function usePacerContext(): PacerContextValue | null;
|
|
26
|
+
declare function useDefaultPacerOptions(): PacerProviderOptions;
|
|
27
|
+
//#endregion
|
|
28
|
+
export { PacerProvider, PacerProviderOptions, PacerProviderProps, useDefaultPacerOptions, usePacerContext };
|
|
29
|
+
//# sourceMappingURL=PacerProvider.d.ts.map
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { createComponent } from "solid-js/web";
|
|
2
|
+
import { createContext, useContext } from "solid-js";
|
|
3
|
+
|
|
4
|
+
//#region src/provider/PacerProvider.tsx
|
|
5
|
+
const PacerContext = createContext(null);
|
|
6
|
+
const DEFAULT_OPTIONS = {};
|
|
7
|
+
function PacerProvider(props) {
|
|
8
|
+
const contextValue = { defaultOptions: props.defaultOptions ?? DEFAULT_OPTIONS };
|
|
9
|
+
return createComponent(PacerContext.Provider, {
|
|
10
|
+
value: contextValue,
|
|
11
|
+
get children() {
|
|
12
|
+
return props.children;
|
|
13
|
+
}
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
function usePacerContext() {
|
|
17
|
+
return useContext(PacerContext);
|
|
18
|
+
}
|
|
19
|
+
function useDefaultPacerOptions() {
|
|
20
|
+
return useContext(PacerContext)?.defaultOptions ?? {};
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
//#endregion
|
|
24
|
+
export { PacerProvider, useDefaultPacerOptions, usePacerContext };
|
|
25
|
+
//# sourceMappingURL=PacerProvider.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PacerProvider.js","names":["createContext","useContext","JSX","AnyAsyncFunction","AnyFunction","AsyncBatcherOptions","AsyncDebouncerOptions","AsyncQueuerOptions","AsyncRateLimiterOptions","AsyncThrottlerOptions","BatcherOptions","DebouncerOptions","QueuerOptions","RateLimiterOptions","ThrottlerOptions","PacerProviderOptions","asyncBatcher","Partial","asyncDebouncer","asyncQueuer","asyncRateLimiter","asyncThrottler","batcher","debouncer","queuer","rateLimiter","throttler","PacerContextValue","defaultOptions","PacerContext","PacerProviderProps","children","Element","DEFAULT_OPTIONS","PacerProvider","props","contextValue","_$createComponent","Provider","value","usePacerContext","useDefaultPacerOptions","context"],"sources":["../../src/provider/PacerProvider.tsx"],"sourcesContent":["import { createContext, useContext } from 'solid-js'\nimport type { JSX } from 'solid-js'\nimport type {\n AnyAsyncFunction,\n AnyFunction,\n AsyncBatcherOptions,\n AsyncDebouncerOptions,\n AsyncQueuerOptions,\n AsyncRateLimiterOptions,\n AsyncThrottlerOptions,\n BatcherOptions,\n DebouncerOptions,\n QueuerOptions,\n RateLimiterOptions,\n ThrottlerOptions,\n} from '@tanstack/pacer'\n\nexport interface PacerProviderOptions {\n asyncBatcher?: Partial<AsyncBatcherOptions<any>>\n asyncDebouncer?: Partial<AsyncDebouncerOptions<AnyAsyncFunction>>\n asyncQueuer?: Partial<AsyncQueuerOptions<any>>\n asyncRateLimiter?: Partial<AsyncRateLimiterOptions<AnyAsyncFunction>>\n asyncThrottler?: Partial<AsyncThrottlerOptions<AnyAsyncFunction>>\n batcher?: Partial<BatcherOptions<any>>\n debouncer?: Partial<DebouncerOptions<AnyFunction>>\n queuer?: Partial<QueuerOptions<any>>\n rateLimiter?: Partial<RateLimiterOptions<AnyFunction>>\n throttler?: Partial<ThrottlerOptions<AnyFunction>>\n}\n\ninterface PacerContextValue {\n defaultOptions: PacerProviderOptions\n}\n\nconst PacerContext = createContext<PacerContextValue | null>(null)\n\nexport interface PacerProviderProps {\n children: JSX.Element\n defaultOptions?: PacerProviderOptions\n}\n\nconst DEFAULT_OPTIONS: PacerProviderOptions = {}\n\nexport function PacerProvider(props: PacerProviderProps) {\n const contextValue: PacerContextValue = {\n defaultOptions: props.defaultOptions ?? DEFAULT_OPTIONS,\n }\n\n return (\n <PacerContext.Provider value={contextValue}>\n {props.children}\n </PacerContext.Provider>\n )\n}\n\nexport function usePacerContext() {\n return useContext(PacerContext)\n}\n\nexport function useDefaultPacerOptions() {\n const context = useContext(PacerContext)\n return context?.defaultOptions ?? {}\n}\n"],"mappings":";;;;AAkCA,MAAM6B,eAAe7B,cAAwC,KAAK;AAOlE,MAAMiC,kBAAwC,EAAE;AAEhD,SAAgBC,cAAcC,OAA2B;CACvD,MAAMC,eAAkC,EACtCR,gBAAgBO,MAAMP,kBAAkBK,iBACzC;AAED,QAAAI,gBACGR,aAAaS,UAAQ;EAACC,OAAOH;EAAY,IAAAL,WAAA;AAAA,UACvCI,MAAMJ;;EAAQ,CAAA;;AAKrB,SAAgBS,kBAAkB;AAChC,QAAOvC,WAAW4B,aAAa;;AAGjC,SAAgBY,yBAAyB;AAEvC,QADgBxC,WAAW4B,aAAa,EACxBD,kBAAkB,EAAE"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
const require_PacerProvider = require('./PacerProvider.cjs');
|
|
2
|
+
|
|
3
|
+
exports.PacerProvider = require_PacerProvider.PacerProvider;
|
|
4
|
+
exports.useDefaultPacerOptions = require_PacerProvider.useDefaultPacerOptions;
|
|
5
|
+
exports.usePacerContext = require_PacerProvider.usePacerContext;
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
const require_createQueuer = require('./createQueuer.cjs');
|
|
2
|
+
|
|
3
|
+
//#region src/queuer/createQueuedSignal.ts
|
|
4
|
+
/**
|
|
5
|
+
* A Solid primitive that creates a queuer with managed state, combining Solid's signals with queuing functionality.
|
|
6
|
+
* This primitive provides both the current queue state and queue control methods.
|
|
7
|
+
*
|
|
8
|
+
* The queue state is automatically updated whenever items are added, removed, or reordered in the queue.
|
|
9
|
+
* All queue operations are reflected in the state array returned by the primitive.
|
|
10
|
+
*
|
|
11
|
+
* The queue can be started and stopped to automatically process items at a specified interval,
|
|
12
|
+
* making it useful as a scheduler. When started, it will process one item per tick, with an
|
|
13
|
+
* optional wait time between ticks.
|
|
14
|
+
*
|
|
15
|
+
* The primitive returns a tuple containing:
|
|
16
|
+
* - The current queue state as an array
|
|
17
|
+
* - The queue instance with methods for queue manipulation
|
|
18
|
+
*
|
|
19
|
+
* ## State Management and Selector
|
|
20
|
+
*
|
|
21
|
+
* The primitive uses Solid's reactive state management via the underlying queuer instance.
|
|
22
|
+
* The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,
|
|
23
|
+
* optimizing performance by preventing unnecessary re-renders when irrelevant state changes occur.
|
|
24
|
+
*
|
|
25
|
+
* **By default, there will be no reactive state subscriptions** and you must opt-in to state
|
|
26
|
+
* tracking by providing a selector function. This prevents unnecessary re-renders and gives you
|
|
27
|
+
* full control over when your component updates. Only when you provide a selector will the
|
|
28
|
+
* component re-render when the selected state values change.
|
|
29
|
+
*
|
|
30
|
+
* Available queuer state properties:
|
|
31
|
+
* - `executionCount`: Number of items that have been processed by the queuer
|
|
32
|
+
* - `expirationCount`: Number of items that have been removed due to expiration
|
|
33
|
+
* - `isEmpty`: Whether the queuer has no items to process
|
|
34
|
+
* - `isFull`: Whether the queuer has reached its maximum capacity
|
|
35
|
+
* - `isIdle`: Whether the queuer is not currently processing any items
|
|
36
|
+
* - `isRunning`: Whether the queuer is active and will process items automatically
|
|
37
|
+
* - `items`: Array of items currently waiting to be processed
|
|
38
|
+
* - `itemTimestamps`: Timestamps when items were added for expiration tracking
|
|
39
|
+
* - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
|
|
40
|
+
* - `rejectionCount`: Number of items that have been rejected from being added
|
|
41
|
+
* - `size`: Number of items currently in the queue
|
|
42
|
+
* - `status`: Current processing status ('idle' | 'running' | 'stopped')
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```tsx
|
|
46
|
+
* // Default behavior - no reactive state subscriptions
|
|
47
|
+
* const [items, addItem, queue] = createQueuedSignal(
|
|
48
|
+
* (item) => console.log('Processing:', item),
|
|
49
|
+
* {
|
|
50
|
+
* initialItems: ['item1', 'item2'],
|
|
51
|
+
* started: true,
|
|
52
|
+
* wait: 1000,
|
|
53
|
+
* getPriority: (item) => item.priority
|
|
54
|
+
* }
|
|
55
|
+
* );
|
|
56
|
+
*
|
|
57
|
+
* // Opt-in to re-render when queue contents change (optimized for displaying queue items)
|
|
58
|
+
* const [items, addItem, queue] = createQueuedSignal(
|
|
59
|
+
* (item) => console.log('Processing:', item),
|
|
60
|
+
* { started: true, wait: 1000 },
|
|
61
|
+
* (state) => ({
|
|
62
|
+
* items: state.items,
|
|
63
|
+
* size: state.size,
|
|
64
|
+
* isEmpty: state.isEmpty
|
|
65
|
+
* })
|
|
66
|
+
* );
|
|
67
|
+
*
|
|
68
|
+
* // Opt-in to re-render when processing state changes (optimized for loading indicators)
|
|
69
|
+
* const [items, addItem, queue] = createQueuedSignal(
|
|
70
|
+
* (item) => console.log('Processing:', item),
|
|
71
|
+
* { started: true, wait: 1000 },
|
|
72
|
+
* (state) => ({
|
|
73
|
+
* isRunning: state.isRunning,
|
|
74
|
+
* isIdle: state.isIdle,
|
|
75
|
+
* status: state.status,
|
|
76
|
+
* pendingTick: state.pendingTick
|
|
77
|
+
* })
|
|
78
|
+
* );
|
|
79
|
+
*
|
|
80
|
+
* // Opt-in to re-render when execution metrics change (optimized for stats display)
|
|
81
|
+
* const [items, addItem, queue] = createQueuedSignal(
|
|
82
|
+
* (item) => console.log('Processing:', item),
|
|
83
|
+
* { started: true, wait: 1000 },
|
|
84
|
+
* (state) => ({
|
|
85
|
+
* executionCount: state.executionCount,
|
|
86
|
+
* expirationCount: state.expirationCount,
|
|
87
|
+
* rejectionCount: state.rejectionCount
|
|
88
|
+
* })
|
|
89
|
+
* );
|
|
90
|
+
*
|
|
91
|
+
* // Add items to queue
|
|
92
|
+
* const handleAdd = (item) => {
|
|
93
|
+
* addItem(item);
|
|
94
|
+
* };
|
|
95
|
+
*
|
|
96
|
+
* // Start automatic processing
|
|
97
|
+
* const startProcessing = () => {
|
|
98
|
+
* queue.start();
|
|
99
|
+
* };
|
|
100
|
+
*
|
|
101
|
+
* // Stop automatic processing
|
|
102
|
+
* const stopProcessing = () => {
|
|
103
|
+
* queue.stop();
|
|
104
|
+
* };
|
|
105
|
+
*
|
|
106
|
+
* // Manual processing still available
|
|
107
|
+
* const handleProcess = () => {
|
|
108
|
+
* const nextItem = queue.getNextItem();
|
|
109
|
+
* if (nextItem) {
|
|
110
|
+
* processItem(nextItem);
|
|
111
|
+
* }
|
|
112
|
+
* };
|
|
113
|
+
*
|
|
114
|
+
* // Access the selected queuer state (will be empty object {} unless selector provided)
|
|
115
|
+
* const { size, isRunning, executionCount } = queue.state;
|
|
116
|
+
* ```
|
|
117
|
+
*/
|
|
118
|
+
function createQueuedSignal(fn, options = {}, selector = (state) => ({ items: state.items })) {
|
|
119
|
+
const queue = require_createQueuer.createQueuer(fn, options, selector);
|
|
120
|
+
return [
|
|
121
|
+
() => queue.state().items,
|
|
122
|
+
queue.addItem,
|
|
123
|
+
queue
|
|
124
|
+
];
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
//#endregion
|
|
128
|
+
exports.createQueuedSignal = createQueuedSignal;
|
|
129
|
+
//# sourceMappingURL=createQueuedSignal.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createQueuedSignal.cjs","names":["createQueuer"],"sources":["../../src/queuer/createQueuedSignal.ts"],"sourcesContent":["import { createQueuer } from './createQueuer'\nimport type { SolidQueuer } from './createQueuer'\nimport type { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer'\n\n/**\n * A Solid primitive that creates a queuer with managed state, combining Solid's signals with queuing functionality.\n * This primitive provides both the current queue state and queue control methods.\n *\n * The queue state is automatically updated whenever items are added, removed, or reordered in the queue.\n * All queue operations are reflected in the state array returned by the primitive.\n *\n * The queue can be started and stopped to automatically process items at a specified interval,\n * making it useful as a scheduler. When started, it will process one item per tick, with an\n * optional wait time between ticks.\n *\n * The primitive returns a tuple containing:\n * - The current queue state as an array\n * - The queue instance with methods for queue manipulation\n *\n * ## State Management and Selector\n *\n * The primitive uses Solid's reactive state management via the underlying queuer instance.\n * The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,\n * optimizing performance by preventing unnecessary re-renders 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 re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available queuer state properties:\n * - `executionCount`: Number of items that have been processed by the queuer\n * - `expirationCount`: Number of items that have been removed due to expiration\n * - `isEmpty`: Whether the queuer has no items to process\n * - `isFull`: Whether the queuer has reached its maximum capacity\n * - `isIdle`: Whether the queuer is not currently processing any items\n * - `isRunning`: Whether the queuer is active and will process items automatically\n * - `items`: Array of items currently waiting to be processed\n * - `itemTimestamps`: Timestamps when items were added for expiration tracking\n * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item\n * - `rejectionCount`: Number of items that have been rejected from being added\n * - `size`: Number of items currently in the queue\n * - `status`: Current processing status ('idle' | 'running' | 'stopped')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [items, addItem, queue] = createQueuedSignal(\n * (item) => console.log('Processing:', item),\n * {\n * initialItems: ['item1', 'item2'],\n * started: true,\n * wait: 1000,\n * getPriority: (item) => item.priority\n * }\n * );\n *\n * // Opt-in to re-render when queue contents change (optimized for displaying queue items)\n * const [items, addItem, queue] = createQueuedSignal(\n * (item) => console.log('Processing:', item),\n * { started: true, wait: 1000 },\n * (state) => ({\n * items: state.items,\n * size: state.size,\n * isEmpty: state.isEmpty\n * })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const [items, addItem, queue] = createQueuedSignal(\n * (item) => console.log('Processing:', item),\n * { started: true, wait: 1000 },\n * (state) => ({\n * isRunning: state.isRunning,\n * isIdle: state.isIdle,\n * status: state.status,\n * pendingTick: state.pendingTick\n * })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const [items, addItem, queue] = createQueuedSignal(\n * (item) => console.log('Processing:', item),\n * { started: true, wait: 1000 },\n * (state) => ({\n * executionCount: state.executionCount,\n * expirationCount: state.expirationCount,\n * rejectionCount: state.rejectionCount\n * })\n * );\n *\n * // Add items to queue\n * const handleAdd = (item) => {\n * addItem(item);\n * };\n *\n * // Start automatic processing\n * const startProcessing = () => {\n * queue.start();\n * };\n *\n * // Stop automatic processing\n * const stopProcessing = () => {\n * queue.stop();\n * };\n *\n * // Manual processing still available\n * const handleProcess = () => {\n * const nextItem = queue.getNextItem();\n * if (nextItem) {\n * processItem(nextItem);\n * }\n * };\n *\n * // Access the selected queuer state (will be empty object {} unless selector provided)\n * const { size, isRunning, executionCount } = queue.state;\n * ```\n */\nexport function createQueuedSignal<\n TValue,\n TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<\n QueuerState<TValue>,\n 'items'\n >,\n>(\n fn: (item: TValue) => void,\n options: QueuerOptions<TValue> = {},\n selector: (state: QueuerState<TValue>) => TSelected = (state) =>\n ({ items: state.items }) as TSelected,\n): [\n () => Array<TValue>,\n SolidQueuer<TValue, TSelected>['addItem'],\n SolidQueuer<TValue, TSelected>,\n] {\n const queue = createQueuer(fn, options, selector)\n\n return [() => queue.state().items, queue.addItem, queue]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsHA,SAAgB,mBAOd,IACA,UAAiC,EAAE,EACnC,YAAuD,WACpD,EAAE,OAAO,MAAM,OAAO,GAKzB;CACA,MAAM,QAAQA,kCAAa,IAAI,SAAS,SAAS;AAEjD,QAAO;QAAO,MAAM,OAAO,CAAC;EAAO,MAAM;EAAS;EAAM"}
|
|
@@ -1,5 +1,8 @@
|
|
|
1
|
-
import { SolidQueuer } from
|
|
2
|
-
import { QueuerOptions, QueuerState } from
|
|
1
|
+
import { SolidQueuer } from "./createQueuer.cjs";
|
|
2
|
+
import { QueuerOptions, QueuerState } from "@tanstack/pacer/queuer";
|
|
3
|
+
|
|
4
|
+
//#region src/queuer/createQueuedSignal.d.ts
|
|
5
|
+
|
|
3
6
|
/**
|
|
4
7
|
* A Solid primitive that creates a queuer with managed state, combining Solid's signals with queuing functionality.
|
|
5
8
|
* This primitive provides both the current queue state and queue control methods.
|
|
@@ -114,8 +117,7 @@ import { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer';
|
|
|
114
117
|
* const { size, isRunning, executionCount } = queue.state;
|
|
115
118
|
* ```
|
|
116
119
|
*/
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
];
|
|
120
|
+
declare function createQueuedSignal<TValue, TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<QueuerState<TValue>, 'items'>>(fn: (item: TValue) => void, options?: QueuerOptions<TValue>, selector?: (state: QueuerState<TValue>) => TSelected): [() => Array<TValue>, SolidQueuer<TValue, TSelected>['addItem'], SolidQueuer<TValue, TSelected>];
|
|
121
|
+
//#endregion
|
|
122
|
+
export { createQueuedSignal };
|
|
123
|
+
//# sourceMappingURL=createQueuedSignal.d.cts.map
|