From eb086eb93ed3dbb0746ca3650f7e3df5aa8833db Mon Sep 17 00:00:00 2001 From: Wonsuk Choi Date: Sun, 25 Oct 2026 12:16:05 +0900 Subject: [PATCH 1/2] fix(solid-pacer): update 'Subscribe' on non-function children and 'selector' changes --- .../solid-pacer-subscribe-reactivity.md | 5 + .../src/async-batcher/createAsyncBatcher.ts | 27 ++-- .../async-debouncer/createAsyncDebouncer.ts | 27 ++-- .../src/async-queuer/createAsyncQueuer.ts | 27 ++-- .../createAsyncRateLimiter.ts | 27 ++-- .../async-throttler/createAsyncThrottler.ts | 27 ++-- .../solid-pacer/src/batcher/createBatcher.ts | 27 ++-- .../src/debouncer/createDebouncer.ts | 27 ++-- .../solid-pacer/src/queuer/createQueuer.ts | 27 ++-- .../src/rate-limiter/createRateLimiter.ts | 27 ++-- .../src/throttler/createThrottler.ts | 27 ++-- packages/solid-pacer/tests/subscribe.test.tsx | 115 ++++++++++++++++++ 12 files changed, 320 insertions(+), 70 deletions(-) create mode 100644 .changeset/solid-pacer-subscribe-reactivity.md create mode 100644 packages/solid-pacer/tests/subscribe.test.tsx diff --git a/.changeset/solid-pacer-subscribe-reactivity.md b/.changeset/solid-pacer-subscribe-reactivity.md new file mode 100644 index 000000000..8c8d85511 --- /dev/null +++ b/.changeset/solid-pacer-subscribe-reactivity.md @@ -0,0 +1,5 @@ +--- +'@tanstack/solid-pacer': patch +--- + +Update `Subscribe` when non-function children change, and apply the latest `selector` prop to subsequent state updates. diff --git a/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts b/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts index 69aed529b..ffc1c66d8 100644 --- a/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts +++ b/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts @@ -1,6 +1,12 @@ import { AsyncBatcher } from '@tanstack/pacer/async-batcher' import { shallow, useSelector } from '@tanstack/solid-store' -import { createEffect, createRenderEffect, onCleanup, untrack } from 'solid-js' +import { + createEffect, + createMemo, + createRenderEffect, + onCleanup, + untrack, +} from 'solid-js' import { createPacerOptions } from '../utils/createPacerOptions' import { useDefaultPacerOptions } from '../provider/PacerProvider' import type { SolidPacerOptions } from '../types' @@ -214,13 +220,20 @@ export function createAsyncBatcher( selector: (state: AsyncBatcherState) => TSelected children: ((state: Accessor) => JSX.Element) | JSX.Element }) { - const selected = useSelector(asyncBatcher.store, props.selector, { - compare: shallow, - }) + const selected = useSelector( + asyncBatcher.store, + (state) => props.selector(state), + { + compare: shallow, + }, + ) - return typeof props.children === 'function' - ? props.children(selected) - : props.children + return createMemo(() => { + const children = props.children + return typeof children === 'function' + ? untrack(() => children(selected)) + : children + }) as unknown as JSX.Element } const state = useSelector(asyncBatcher.store, selector, { compare: shallow }) diff --git a/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts b/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts index c3e2d7c1d..5a4afe7ad 100644 --- a/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts +++ b/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts @@ -1,6 +1,12 @@ import { AsyncDebouncer } from '@tanstack/pacer/async-debouncer' import { shallow, useSelector } from '@tanstack/solid-store' -import { createEffect, createRenderEffect, onCleanup, untrack } from 'solid-js' +import { + createEffect, + createMemo, + createRenderEffect, + onCleanup, + untrack, +} from 'solid-js' import { createPacerOptions } from '../utils/createPacerOptions' import { useDefaultPacerOptions } from '../provider/PacerProvider' import type { SolidPacerOptions } from '../types' @@ -204,13 +210,20 @@ export function createAsyncDebouncer< selector: (state: AsyncDebouncerState) => TSelected children: ((state: Accessor) => JSX.Element) | JSX.Element }) { - const selected = useSelector(asyncDebouncer.store, props.selector, { - compare: shallow, - }) + const selected = useSelector( + asyncDebouncer.store, + (state) => props.selector(state), + { + compare: shallow, + }, + ) - return typeof props.children === 'function' - ? props.children(selected) - : props.children + return createMemo(() => { + const children = props.children + return typeof children === 'function' + ? untrack(() => children(selected)) + : children + }) as unknown as JSX.Element } const state = useSelector(asyncDebouncer.store, selector, { diff --git a/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts b/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts index f85a5d227..3c5ed8e53 100644 --- a/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts +++ b/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts @@ -1,6 +1,12 @@ import { AsyncQueuer } from '@tanstack/pacer/async-queuer' import { shallow, useSelector } from '@tanstack/solid-store' -import { createEffect, createRenderEffect, onCleanup, untrack } from 'solid-js' +import { + createEffect, + createMemo, + createRenderEffect, + onCleanup, + untrack, +} from 'solid-js' import { createPacerOptions } from '../utils/createPacerOptions' import { useDefaultPacerOptions } from '../provider/PacerProvider' import type { SolidPacerOptions } from '../types' @@ -208,13 +214,20 @@ export function createAsyncQueuer( selector: (state: AsyncQueuerState) => TSelected children: ((state: Accessor) => JSX.Element) | JSX.Element }) { - const selected = useSelector(asyncQueuer.store, props.selector, { - compare: shallow, - }) + const selected = useSelector( + asyncQueuer.store, + (state) => props.selector(state), + { + compare: shallow, + }, + ) - return typeof props.children === 'function' - ? props.children(selected) - : props.children + return createMemo(() => { + const children = props.children + return typeof children === 'function' + ? untrack(() => children(selected)) + : children + }) as unknown as JSX.Element } const state = useSelector(asyncQueuer.store, selector, { compare: shallow }) diff --git a/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts b/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts index 81ae8744b..fc9055b19 100644 --- a/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts +++ b/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts @@ -1,5 +1,11 @@ import { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter' -import { createEffect, createRenderEffect, onCleanup, untrack } from 'solid-js' +import { + createEffect, + createMemo, + createRenderEffect, + onCleanup, + untrack, +} from 'solid-js' import { shallow, useSelector } from '@tanstack/solid-store' import { createPacerOptions } from '../utils/createPacerOptions' import { useDefaultPacerOptions } from '../provider/PacerProvider' @@ -250,13 +256,20 @@ export function createAsyncRateLimiter< selector: (state: AsyncRateLimiterState) => TSelected children: ((state: Accessor) => JSX.Element) | JSX.Element }) { - const selected = useSelector(asyncRateLimiter.store, props.selector, { - compare: shallow, - }) + const selected = useSelector( + asyncRateLimiter.store, + (state) => props.selector(state), + { + compare: shallow, + }, + ) - return typeof props.children === 'function' - ? props.children(selected) - : props.children + return createMemo(() => { + const children = props.children + return typeof children === 'function' + ? untrack(() => children(selected)) + : children + }) as unknown as JSX.Element } const state = useSelector(asyncRateLimiter.store, selector, { diff --git a/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts b/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts index 83ef46774..09744640d 100644 --- a/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts +++ b/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts @@ -1,4 +1,10 @@ -import { createEffect, createRenderEffect, onCleanup, untrack } from 'solid-js' +import { + createEffect, + createMemo, + createRenderEffect, + onCleanup, + untrack, +} from 'solid-js' import { AsyncThrottler } from '@tanstack/pacer/async-throttler' import { shallow, useSelector } from '@tanstack/solid-store' import { createPacerOptions } from '../utils/createPacerOptions' @@ -202,13 +208,20 @@ export function createAsyncThrottler< selector: (state: AsyncThrottlerState) => TSelected children: ((state: Accessor) => JSX.Element) | JSX.Element }) { - const selected = useSelector(asyncThrottler.store, props.selector, { - compare: shallow, - }) + const selected = useSelector( + asyncThrottler.store, + (state) => props.selector(state), + { + compare: shallow, + }, + ) - return typeof props.children === 'function' - ? props.children(selected) - : props.children + return createMemo(() => { + const children = props.children + return typeof children === 'function' + ? untrack(() => children(selected)) + : children + }) as unknown as JSX.Element } const state = useSelector(asyncThrottler.store, selector, { diff --git a/packages/solid-pacer/src/batcher/createBatcher.ts b/packages/solid-pacer/src/batcher/createBatcher.ts index e9e131c97..01af29c9d 100644 --- a/packages/solid-pacer/src/batcher/createBatcher.ts +++ b/packages/solid-pacer/src/batcher/createBatcher.ts @@ -1,6 +1,12 @@ import { Batcher } from '@tanstack/pacer/batcher' import { shallow, useSelector } from '@tanstack/solid-store' -import { createEffect, createRenderEffect, onCleanup, untrack } from 'solid-js' +import { + createEffect, + createMemo, + createRenderEffect, + onCleanup, + untrack, +} from 'solid-js' import { createPacerOptions } from '../utils/createPacerOptions' import { useDefaultPacerOptions } from '../provider/PacerProvider' import type { SolidPacerOptions } from '../types' @@ -178,13 +184,20 @@ export function createBatcher( selector: (state: BatcherState) => TSelected children: ((state: Accessor) => JSX.Element) | JSX.Element }) { - const selected = useSelector(batcher.store, props.selector, { - compare: shallow, - }) + const selected = useSelector( + batcher.store, + (state) => props.selector(state), + { + compare: shallow, + }, + ) - return typeof props.children === 'function' - ? props.children(selected) - : props.children + return createMemo(() => { + const children = props.children + return typeof children === 'function' + ? untrack(() => children(selected)) + : children + }) as unknown as JSX.Element } const state = useSelector(batcher.store, selector, { compare: shallow }) diff --git a/packages/solid-pacer/src/debouncer/createDebouncer.ts b/packages/solid-pacer/src/debouncer/createDebouncer.ts index 94f205afb..3fe2bb3b1 100644 --- a/packages/solid-pacer/src/debouncer/createDebouncer.ts +++ b/packages/solid-pacer/src/debouncer/createDebouncer.ts @@ -1,5 +1,11 @@ import { Debouncer } from '@tanstack/pacer/debouncer' -import { createEffect, createRenderEffect, onCleanup, untrack } from 'solid-js' +import { + createEffect, + createMemo, + createRenderEffect, + onCleanup, + untrack, +} from 'solid-js' import { shallow, useSelector } from '@tanstack/solid-store' import { createPacerOptions } from '../utils/createPacerOptions' import { useDefaultPacerOptions } from '../provider/PacerProvider' @@ -179,13 +185,20 @@ export function createDebouncer( selector: (state: DebouncerState) => TSelected children: ((state: Accessor) => JSX.Element) | JSX.Element }) { - const selected = useSelector(asyncDebouncer.store, props.selector, { - compare: shallow, - }) + const selected = useSelector( + asyncDebouncer.store, + (state) => props.selector(state), + { + compare: shallow, + }, + ) - return typeof props.children === 'function' - ? props.children(selected) - : props.children + return createMemo(() => { + const children = props.children + return typeof children === 'function' + ? untrack(() => children(selected)) + : children + }) as unknown as JSX.Element } const state = useSelector(asyncDebouncer.store, selector, { diff --git a/packages/solid-pacer/src/queuer/createQueuer.ts b/packages/solid-pacer/src/queuer/createQueuer.ts index 656fef2dc..d57ff8331 100644 --- a/packages/solid-pacer/src/queuer/createQueuer.ts +++ b/packages/solid-pacer/src/queuer/createQueuer.ts @@ -1,6 +1,12 @@ import { Queuer } from '@tanstack/pacer/queuer' import { shallow, useSelector } from '@tanstack/solid-store' -import { createEffect, createRenderEffect, onCleanup, untrack } from 'solid-js' +import { + createEffect, + createMemo, + createRenderEffect, + onCleanup, + untrack, +} from 'solid-js' import { createPacerOptions } from '../utils/createPacerOptions' import { useDefaultPacerOptions } from '../provider/PacerProvider' import type { SolidPacerOptions } from '../types' @@ -179,13 +185,20 @@ export function createQueuer( selector: (state: QueuerState) => TSelected children: ((state: Accessor) => JSX.Element) | JSX.Element }) { - const selected = useSelector(queuer.store, props.selector, { - compare: shallow, - }) + const selected = useSelector( + queuer.store, + (state) => props.selector(state), + { + compare: shallow, + }, + ) - return typeof props.children === 'function' - ? props.children(selected) - : props.children + return createMemo(() => { + const children = props.children + return typeof children === 'function' + ? untrack(() => children(selected)) + : children + }) as unknown as JSX.Element } const state = useSelector(queuer.store, selector, { compare: shallow }) diff --git a/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts b/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts index 2dbc5223b..30e729f76 100644 --- a/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts +++ b/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts @@ -1,5 +1,11 @@ import { RateLimiter } from '@tanstack/pacer/rate-limiter' -import { createEffect, createRenderEffect, onCleanup, untrack } from 'solid-js' +import { + createEffect, + createMemo, + createRenderEffect, + onCleanup, + untrack, +} from 'solid-js' import { shallow, useSelector } from '@tanstack/solid-store' import { createPacerOptions } from '../utils/createPacerOptions' import { useDefaultPacerOptions } from '../provider/PacerProvider' @@ -211,13 +217,20 @@ export function createRateLimiter( selector: (state: RateLimiterState) => TSelected children: ((state: Accessor) => JSX.Element) | JSX.Element }) { - const selected = useSelector(rateLimiter.store, props.selector, { - compare: shallow, - }) + const selected = useSelector( + rateLimiter.store, + (state) => props.selector(state), + { + compare: shallow, + }, + ) - return typeof props.children === 'function' - ? props.children(selected) - : props.children + return createMemo(() => { + const children = props.children + return typeof children === 'function' + ? untrack(() => children(selected)) + : children + }) as unknown as JSX.Element } const state = useSelector(rateLimiter.store, selector, { compare: shallow }) diff --git a/packages/solid-pacer/src/throttler/createThrottler.ts b/packages/solid-pacer/src/throttler/createThrottler.ts index 675efd945..884c90e21 100644 --- a/packages/solid-pacer/src/throttler/createThrottler.ts +++ b/packages/solid-pacer/src/throttler/createThrottler.ts @@ -1,5 +1,11 @@ import { Throttler } from '@tanstack/pacer/throttler' -import { createEffect, createRenderEffect, onCleanup, untrack } from 'solid-js' +import { + createEffect, + createMemo, + createRenderEffect, + onCleanup, + untrack, +} from 'solid-js' import { shallow, useSelector } from '@tanstack/solid-store' import { createPacerOptions } from '../utils/createPacerOptions' import { useDefaultPacerOptions } from '../provider/PacerProvider' @@ -180,13 +186,20 @@ export function createThrottler( selector: (state: ThrottlerState) => TSelected children: ((state: Accessor) => JSX.Element) | JSX.Element }) { - const selected = useSelector(asyncThrottler.store, props.selector, { - compare: shallow, - }) + const selected = useSelector( + asyncThrottler.store, + (state) => props.selector(state), + { + compare: shallow, + }, + ) - return typeof props.children === 'function' - ? props.children(selected) - : props.children + return createMemo(() => { + const children = props.children + return typeof children === 'function' + ? untrack(() => children(selected)) + : children + }) as unknown as JSX.Element } const state = useSelector(asyncThrottler.store, selector, { diff --git a/packages/solid-pacer/tests/subscribe.test.tsx b/packages/solid-pacer/tests/subscribe.test.tsx new file mode 100644 index 000000000..15c2d489f --- /dev/null +++ b/packages/solid-pacer/tests/subscribe.test.tsx @@ -0,0 +1,115 @@ +import { createRoot, createSignal } from 'solid-js' +import { render } from 'solid-js/web' +import { describe, expect, it } from 'vitest' +import { + createAsyncBatcher, + createAsyncDebouncer, + createAsyncQueuer, + createAsyncRateLimiter, + createAsyncThrottler, + createBatcher, + createDebouncer, + createQueuer, + createRateLimiter, + createThrottler, +} from '../src' +import type { JSX } from 'solid-js' + +type SubscribeUtility = { + Subscribe: (props: { + selector: (state: any) => unknown + children: JSX.Element | ((state: () => unknown) => JSX.Element) + }) => JSX.Element +} + +const utilities: Array<[string, () => SubscribeUtility]> = [ + ['createAsyncBatcher', () => createAsyncBatcher(() => Promise.resolve())], + [ + 'createAsyncDebouncer', + () => createAsyncDebouncer(() => Promise.resolve(), { wait: 100 }), + ], + ['createAsyncQueuer', () => createAsyncQueuer(() => Promise.resolve())], + [ + 'createAsyncRateLimiter', + () => + createAsyncRateLimiter(() => Promise.resolve(), { + limit: 1, + window: 100, + }), + ], + [ + 'createAsyncThrottler', + () => createAsyncThrottler(() => Promise.resolve(), { wait: 100 }), + ], + ['createBatcher', () => createBatcher(() => {})], + ['createDebouncer', () => createDebouncer(() => {}, { wait: 100 })], + ['createQueuer', () => createQueuer(() => {})], + [ + 'createRateLimiter', + () => createRateLimiter(() => {}, { limit: 1, window: 100 }), + ], + ['createThrottler', () => createThrottler(() => {}, { wait: 100 })], +] + +describe('Subscribe', () => { + it.each(utilities)( + '%s should update non-function children when they change', + (_name, createUtility) => { + const container = document.createElement('div') + const [isOn, setIsOn] = createSignal(true) + + const dispose = createRoot((dispose) => { + const utility = createUtility() + render( + () => ( + state}> + {isOn() ? on : off} + + ), + container, + ) + return dispose + }) + + expect(container.innerHTML).toBe('on') + + setIsOn(false) + + expect(container.innerHTML).toBe('off') + + dispose() + }, + ) + + it('should use the latest selector when the state changes', () => { + const container = document.createElement('div') + const [selector, setSelector] = createSignal( + (state: { maybeExecuteCount: number }) => `a:${state.maybeExecuteCount}`, + ) + + const { debouncer, dispose } = createRoot((dispose) => { + const debouncer = createDebouncer(() => {}, { wait: 100 }) + render( + () => ( + + {(selected) => {selected()}} + + ), + container, + ) + return { debouncer, dispose } + }) + + expect(container.textContent).toBe('a:0') + + setSelector( + () => (state: { maybeExecuteCount: number }) => + `b:${state.maybeExecuteCount}`, + ) + debouncer.maybeExecute() + + expect(container.textContent).toBe('b:1') + + dispose() + }) +}) From ee897440b9c6b8935777d27d814217fcff884dde Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Sun, 25 Oct 2026 03:17:25 +0000 Subject: [PATCH 2/2] ci: apply automated fixes --- .../solid/reference/functions/createAsyncBatcher.md | 2 +- .../reference/functions/createAsyncDebouncer.md | 2 +- .../solid/reference/functions/createAsyncQueuer.md | 2 +- .../reference/functions/createAsyncRateLimiter.md | 2 +- .../reference/functions/createAsyncThrottler.md | 2 +- .../solid/reference/functions/createBatcher.md | 2 +- .../solid/reference/functions/createDebouncer.md | 2 +- .../solid/reference/functions/createQueuer.md | 2 +- .../solid/reference/functions/createRateLimiter.md | 2 +- .../solid/reference/functions/createThrottler.md | 2 +- .../solid/reference/interfaces/SolidAsyncBatcher.md | 12 ++++++------ .../reference/interfaces/SolidAsyncBatcherOptions.md | 4 ++-- .../reference/interfaces/SolidAsyncDebouncer.md | 12 ++++++------ .../interfaces/SolidAsyncDebouncerOptions.md | 4 ++-- .../solid/reference/interfaces/SolidAsyncQueuer.md | 12 ++++++------ .../reference/interfaces/SolidAsyncQueuerOptions.md | 4 ++-- .../reference/interfaces/SolidAsyncRateLimiter.md | 12 ++++++------ .../interfaces/SolidAsyncRateLimiterOptions.md | 4 ++-- .../reference/interfaces/SolidAsyncThrottler.md | 12 ++++++------ .../interfaces/SolidAsyncThrottlerOptions.md | 4 ++-- .../solid/reference/interfaces/SolidBatcher.md | 12 ++++++------ .../reference/interfaces/SolidBatcherOptions.md | 4 ++-- .../solid/reference/interfaces/SolidDebouncer.md | 12 ++++++------ .../reference/interfaces/SolidDebouncerOptions.md | 4 ++-- .../solid/reference/interfaces/SolidQueuer.md | 12 ++++++------ .../solid/reference/interfaces/SolidQueuerOptions.md | 4 ++-- .../solid/reference/interfaces/SolidRateLimiter.md | 12 ++++++------ .../reference/interfaces/SolidRateLimiterOptions.md | 4 ++-- .../solid/reference/interfaces/SolidThrottler.md | 12 ++++++------ .../reference/interfaces/SolidThrottlerOptions.md | 4 ++-- 30 files changed, 90 insertions(+), 90 deletions(-) diff --git a/docs/framework/solid/reference/functions/createAsyncBatcher.md b/docs/framework/solid/reference/functions/createAsyncBatcher.md index 15fbc69a2..6edfffaa4 100644 --- a/docs/framework/solid/reference/functions/createAsyncBatcher.md +++ b/docs/framework/solid/reference/functions/createAsyncBatcher.md @@ -10,7 +10,7 @@ function createAsyncBatcher( selector?): SolidAsyncBatcher; ``` -Defined in: [async-batcher/createAsyncBatcher.ts:195](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L195) +Defined in: [async-batcher/createAsyncBatcher.ts:201](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L201) Creates a Solid-compatible AsyncBatcher instance for managing asynchronous batches of items, exposing Solid signals for all stateful properties. diff --git a/docs/framework/solid/reference/functions/createAsyncDebouncer.md b/docs/framework/solid/reference/functions/createAsyncDebouncer.md index 8eb3761a5..4ca45eab9 100644 --- a/docs/framework/solid/reference/functions/createAsyncDebouncer.md +++ b/docs/framework/solid/reference/functions/createAsyncDebouncer.md @@ -10,7 +10,7 @@ function createAsyncDebouncer( selector?): SolidAsyncDebouncer; ``` -Defined in: [async-debouncer/createAsyncDebouncer.ts:182](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L182) +Defined in: [async-debouncer/createAsyncDebouncer.ts:188](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L188) A low-level Solid hook that creates an `AsyncDebouncer` instance to delay execution of an async function. diff --git a/docs/framework/solid/reference/functions/createAsyncQueuer.md b/docs/framework/solid/reference/functions/createAsyncQueuer.md index 9b2f65486..e4edc5421 100644 --- a/docs/framework/solid/reference/functions/createAsyncQueuer.md +++ b/docs/framework/solid/reference/functions/createAsyncQueuer.md @@ -10,7 +10,7 @@ function createAsyncQueuer( selector?): SolidAsyncQueuer; ``` -Defined in: [async-queuer/createAsyncQueuer.ts:189](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L189) +Defined in: [async-queuer/createAsyncQueuer.ts:195](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L195) Creates a Solid-compatible AsyncQueuer instance for managing an asynchronous queue of items, exposing Solid signals for all stateful properties. diff --git a/docs/framework/solid/reference/functions/createAsyncRateLimiter.md b/docs/framework/solid/reference/functions/createAsyncRateLimiter.md index 0e71c9c70..81c99f4cc 100644 --- a/docs/framework/solid/reference/functions/createAsyncRateLimiter.md +++ b/docs/framework/solid/reference/functions/createAsyncRateLimiter.md @@ -10,7 +10,7 @@ function createAsyncRateLimiter( selector?): SolidAsyncRateLimiter; ``` -Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:228](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L228) +Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:234](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L234) A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window. diff --git a/docs/framework/solid/reference/functions/createAsyncThrottler.md b/docs/framework/solid/reference/functions/createAsyncThrottler.md index b97dd7e0b..d109c68dd 100644 --- a/docs/framework/solid/reference/functions/createAsyncThrottler.md +++ b/docs/framework/solid/reference/functions/createAsyncThrottler.md @@ -10,7 +10,7 @@ function createAsyncThrottler( selector?): SolidAsyncThrottler; ``` -Defined in: [async-throttler/createAsyncThrottler.ts:180](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L180) +Defined in: [async-throttler/createAsyncThrottler.ts:186](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L186) A low-level Solid hook that creates an `AsyncThrottler` instance to limit how often an async function can execute. diff --git a/docs/framework/solid/reference/functions/createBatcher.md b/docs/framework/solid/reference/functions/createBatcher.md index 827ef7b7a..68c0d30dc 100644 --- a/docs/framework/solid/reference/functions/createBatcher.md +++ b/docs/framework/solid/reference/functions/createBatcher.md @@ -10,7 +10,7 @@ function createBatcher( selector?): SolidBatcher; ``` -Defined in: [batcher/createBatcher.ts:159](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L159) +Defined in: [batcher/createBatcher.ts:165](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L165) Creates a Solid-compatible Batcher instance for managing batches of items, exposing Solid signals for all stateful properties. diff --git a/docs/framework/solid/reference/functions/createDebouncer.md b/docs/framework/solid/reference/functions/createDebouncer.md index 7a79d2cb6..00bd37cd0 100644 --- a/docs/framework/solid/reference/functions/createDebouncer.md +++ b/docs/framework/solid/reference/functions/createDebouncer.md @@ -10,7 +10,7 @@ function createDebouncer( selector?): SolidDebouncer; ``` -Defined in: [debouncer/createDebouncer.ts:161](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L161) +Defined in: [debouncer/createDebouncer.ts:167](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L167) A Solid hook that creates and manages a Debouncer instance. diff --git a/docs/framework/solid/reference/functions/createQueuer.md b/docs/framework/solid/reference/functions/createQueuer.md index 9b62a78ef..29f8f4503 100644 --- a/docs/framework/solid/reference/functions/createQueuer.md +++ b/docs/framework/solid/reference/functions/createQueuer.md @@ -10,7 +10,7 @@ function createQueuer( selector?): SolidQueuer; ``` -Defined in: [queuer/createQueuer.ts:161](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L161) +Defined in: [queuer/createQueuer.ts:167](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L167) Creates a Solid-compatible Queuer instance for managing a synchronous queue of items, exposing Solid signals for all stateful properties. diff --git a/docs/framework/solid/reference/functions/createRateLimiter.md b/docs/framework/solid/reference/functions/createRateLimiter.md index 3fec48c6f..8c325d133 100644 --- a/docs/framework/solid/reference/functions/createRateLimiter.md +++ b/docs/framework/solid/reference/functions/createRateLimiter.md @@ -10,7 +10,7 @@ function createRateLimiter( selector?): SolidRateLimiter; ``` -Defined in: [rate-limiter/createRateLimiter.ts:193](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L193) +Defined in: [rate-limiter/createRateLimiter.ts:199](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L199) A low-level Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution. diff --git a/docs/framework/solid/reference/functions/createThrottler.md b/docs/framework/solid/reference/functions/createThrottler.md index d3dd29c72..f0322775f 100644 --- a/docs/framework/solid/reference/functions/createThrottler.md +++ b/docs/framework/solid/reference/functions/createThrottler.md @@ -10,7 +10,7 @@ function createThrottler( selector?): SolidThrottler; ``` -Defined in: [throttler/createThrottler.ts:162](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L162) +Defined in: [throttler/createThrottler.ts:168](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L168) A low-level Solid hook that creates a `Throttler` instance that limits how often the provided function can execute. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncBatcher.md b/docs/framework/solid/reference/interfaces/SolidAsyncBatcher.md index ba7d932e0..4285fdec0 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncBatcher.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncBatcher.md @@ -3,7 +3,7 @@ id: SolidAsyncBatcher title: SolidAsyncBatcher --- -Defined in: [async-batcher/createAsyncBatcher.ts:25](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L25) +Defined in: [async-batcher/createAsyncBatcher.ts:31](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L31) ## Extends @@ -40,7 +40,7 @@ options: Omit>, | "onItemsChange">> & SolidAsyncBatcherOptions; ``` -Defined in: [async-batcher/createAsyncBatcher.ts:29](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L29) +Defined in: [async-batcher/createAsyncBatcher.ts:35](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L35) #### Overrides @@ -56,7 +56,7 @@ Omit.options setOptions: (options) => void; ``` -Defined in: [async-batcher/createAsyncBatcher.ts:31](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L31) +Defined in: [async-batcher/createAsyncBatcher.ts:37](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L37) Updates the async batcher options @@ -84,7 +84,7 @@ Omit.setOptions readonly state: Accessor>; ``` -Defined in: [async-batcher/createAsyncBatcher.ts:57](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L57) +Defined in: [async-batcher/createAsyncBatcher.ts:63](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L63) Reactive state that will be updated when the batcher state changes @@ -98,7 +98,7 @@ Use this instead of `batcher.store.state` readonly store: Store>>; ``` -Defined in: [async-batcher/createAsyncBatcher.ts:63](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L63) +Defined in: [async-batcher/createAsyncBatcher.ts:69](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L69) #### Deprecated @@ -114,7 +114,7 @@ Although, you can make the state reactive by using the `useSelector` in your own Subscribe: (props) => Element; ``` -Defined in: [async-batcher/createAsyncBatcher.ts:48](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L48) +Defined in: [async-batcher/createAsyncBatcher.ts:54](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L54) A Solid component that allows you to subscribe to the batcher state. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncBatcherOptions.md b/docs/framework/solid/reference/interfaces/SolidAsyncBatcherOptions.md index 746b2fea7..23efbb16f 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncBatcherOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncBatcherOptions.md @@ -3,7 +3,7 @@ id: SolidAsyncBatcherOptions title: SolidAsyncBatcherOptions --- -Defined in: [async-batcher/createAsyncBatcher.ts:14](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L14) +Defined in: [async-batcher/createAsyncBatcher.ts:20](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L20) ## Extends @@ -28,7 +28,7 @@ Defined in: [async-batcher/createAsyncBatcher.ts:14](https://github.com/TanStack optional onUnmount?: (batcher) => void; ``` -Defined in: [async-batcher/createAsyncBatcher.ts:22](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L22) +Defined in: [async-batcher/createAsyncBatcher.ts:28](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L28) Optional callback invoked when the owning component unmounts. Receives the batcher instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncDebouncer.md b/docs/framework/solid/reference/interfaces/SolidAsyncDebouncer.md index 7046467ce..522b950e6 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncDebouncer.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncDebouncer.md @@ -3,7 +3,7 @@ id: SolidAsyncDebouncer title: SolidAsyncDebouncer --- -Defined in: [async-debouncer/createAsyncDebouncer.ts:26](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L26) +Defined in: [async-debouncer/createAsyncDebouncer.ts:32](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L32) ## Extends @@ -28,7 +28,7 @@ Defined in: [async-debouncer/createAsyncDebouncer.ts:26](https://github.com/TanS options: AsyncDebouncerOptions & SolidAsyncDebouncerOptions; ``` -Defined in: [async-debouncer/createAsyncDebouncer.ts:30](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L30) +Defined in: [async-debouncer/createAsyncDebouncer.ts:36](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L36) #### Overrides @@ -44,7 +44,7 @@ Omit.options setOptions: (options) => void; ``` -Defined in: [async-debouncer/createAsyncDebouncer.ts:32](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L32) +Defined in: [async-debouncer/createAsyncDebouncer.ts:38](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L38) Updates the async debouncer options @@ -72,7 +72,7 @@ Omit.setOptions readonly state: Accessor>; ``` -Defined in: [async-debouncer/createAsyncDebouncer.ts:58](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L58) +Defined in: [async-debouncer/createAsyncDebouncer.ts:64](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L64) Reactive state that will be updated when the debouncer state changes @@ -86,7 +86,7 @@ Use this instead of `debouncer.store.state` readonly store: Store>>; ``` -Defined in: [async-debouncer/createAsyncDebouncer.ts:64](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L64) +Defined in: [async-debouncer/createAsyncDebouncer.ts:70](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L70) #### Deprecated @@ -102,7 +102,7 @@ Although, you can make the state reactive by using the `useSelector` in your own Subscribe: (props) => Element; ``` -Defined in: [async-debouncer/createAsyncDebouncer.ts:49](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L49) +Defined in: [async-debouncer/createAsyncDebouncer.ts:55](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L55) A Solid component that allows you to subscribe to the debouncer state. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncDebouncerOptions.md b/docs/framework/solid/reference/interfaces/SolidAsyncDebouncerOptions.md index ea6d5126f..5dc0eb321 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncDebouncerOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncDebouncerOptions.md @@ -3,7 +3,7 @@ id: SolidAsyncDebouncerOptions title: SolidAsyncDebouncerOptions --- -Defined in: [async-debouncer/createAsyncDebouncer.ts:15](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L15) +Defined in: [async-debouncer/createAsyncDebouncer.ts:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L21) ## Extends @@ -28,7 +28,7 @@ Defined in: [async-debouncer/createAsyncDebouncer.ts:15](https://github.com/TanS optional onUnmount?: (debouncer) => void; ``` -Defined in: [async-debouncer/createAsyncDebouncer.ts:23](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L23) +Defined in: [async-debouncer/createAsyncDebouncer.ts:29](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L29) Optional callback invoked when the owning component unmounts. Receives the debouncer instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncQueuer.md b/docs/framework/solid/reference/interfaces/SolidAsyncQueuer.md index 12e4e8a64..6c6e63647 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncQueuer.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncQueuer.md @@ -3,7 +3,7 @@ id: SolidAsyncQueuer title: SolidAsyncQueuer --- -Defined in: [async-queuer/createAsyncQueuer.ts:25](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L25) +Defined in: [async-queuer/createAsyncQueuer.ts:31](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L31) ## Extends @@ -28,7 +28,7 @@ Defined in: [async-queuer/createAsyncQueuer.ts:25](https://github.com/TanStack/p options: AsyncQueuerOptions & SolidAsyncQueuerOptions; ``` -Defined in: [async-queuer/createAsyncQueuer.ts:29](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L29) +Defined in: [async-queuer/createAsyncQueuer.ts:35](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L35) #### Overrides @@ -44,7 +44,7 @@ Omit.options setOptions: (options) => void; ``` -Defined in: [async-queuer/createAsyncQueuer.ts:31](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L31) +Defined in: [async-queuer/createAsyncQueuer.ts:37](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L37) Updates the queuer options. New options are merged with existing options. @@ -72,7 +72,7 @@ Omit.setOptions readonly state: Accessor>; ``` -Defined in: [async-queuer/createAsyncQueuer.ts:57](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L57) +Defined in: [async-queuer/createAsyncQueuer.ts:63](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L63) Reactive state that will be updated when the queuer state changes @@ -86,7 +86,7 @@ Use this instead of `queuer.store.state` readonly store: Store>>; ``` -Defined in: [async-queuer/createAsyncQueuer.ts:63](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L63) +Defined in: [async-queuer/createAsyncQueuer.ts:69](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L69) #### Deprecated @@ -102,7 +102,7 @@ Although, you can make the state reactive by using the `useSelector` in your own Subscribe: (props) => Element; ``` -Defined in: [async-queuer/createAsyncQueuer.ts:48](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L48) +Defined in: [async-queuer/createAsyncQueuer.ts:54](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L54) A Solid component that allows you to subscribe to the queuer state. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncQueuerOptions.md b/docs/framework/solid/reference/interfaces/SolidAsyncQueuerOptions.md index 21d650912..e6124c5fa 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncQueuerOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncQueuerOptions.md @@ -3,7 +3,7 @@ id: SolidAsyncQueuerOptions title: SolidAsyncQueuerOptions --- -Defined in: [async-queuer/createAsyncQueuer.ts:14](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L14) +Defined in: [async-queuer/createAsyncQueuer.ts:20](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L20) ## Extends @@ -28,7 +28,7 @@ Defined in: [async-queuer/createAsyncQueuer.ts:14](https://github.com/TanStack/p optional onUnmount?: (queuer) => void; ``` -Defined in: [async-queuer/createAsyncQueuer.ts:22](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L22) +Defined in: [async-queuer/createAsyncQueuer.ts:28](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L28) Optional callback invoked when the owning component unmounts. Receives the queuer instance. When provided, replaces the default cleanup (stop + abort); use it to call flush(), flushAsBatch(), stop(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiter.md b/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiter.md index 2a86db54e..282e80c28 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiter.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiter.md @@ -3,7 +3,7 @@ id: SolidAsyncRateLimiter title: SolidAsyncRateLimiter --- -Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:26](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L26) +Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:32](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L32) ## Extends @@ -28,7 +28,7 @@ Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:26](https://github.com options: AsyncRateLimiterOptions & SolidAsyncRateLimiterOptions; ``` -Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:30](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L30) +Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:36](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L36) #### Overrides @@ -44,7 +44,7 @@ Omit.options setOptions: (options) => void; ``` -Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:32](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L32) +Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:38](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L38) Updates the async rate limiter options @@ -72,7 +72,7 @@ Omit.setOptions readonly state: Accessor>; ``` -Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:58](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L58) +Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:64](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L64) Reactive state that will be updated when the rate limiter state changes @@ -86,7 +86,7 @@ Use this instead of `rateLimiter.store.state` readonly store: Store>>; ``` -Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:64](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L64) +Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:70](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L70) #### Deprecated @@ -102,7 +102,7 @@ Although, you can make the state reactive by using the `useSelector` in your own Subscribe: (props) => Element; ``` -Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:49](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L49) +Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:55](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L55) A Solid component that allows you to subscribe to the rate limiter state. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiterOptions.md b/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiterOptions.md index 23b607890..7a7f64d93 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiterOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiterOptions.md @@ -3,7 +3,7 @@ id: SolidAsyncRateLimiterOptions title: SolidAsyncRateLimiterOptions --- -Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:15](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L15) +Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L21) ## Extends @@ -28,7 +28,7 @@ Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:15](https://github.com optional onUnmount?: (rateLimiter) => void; ``` -Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:23](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L23) +Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:29](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L29) Optional callback invoked when the owning component unmounts. Receives the rate limiter instance. When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncThrottler.md b/docs/framework/solid/reference/interfaces/SolidAsyncThrottler.md index df5eea1e1..5c57fff16 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncThrottler.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncThrottler.md @@ -3,7 +3,7 @@ id: SolidAsyncThrottler title: SolidAsyncThrottler --- -Defined in: [async-throttler/createAsyncThrottler.ts:26](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L26) +Defined in: [async-throttler/createAsyncThrottler.ts:32](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L32) ## Extends @@ -28,7 +28,7 @@ Defined in: [async-throttler/createAsyncThrottler.ts:26](https://github.com/TanS options: AsyncThrottlerOptions & SolidAsyncThrottlerOptions; ``` -Defined in: [async-throttler/createAsyncThrottler.ts:30](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L30) +Defined in: [async-throttler/createAsyncThrottler.ts:36](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L36) #### Overrides @@ -44,7 +44,7 @@ Omit.options setOptions: (options) => void; ``` -Defined in: [async-throttler/createAsyncThrottler.ts:32](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L32) +Defined in: [async-throttler/createAsyncThrottler.ts:38](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L38) Updates the async throttler options @@ -72,7 +72,7 @@ Omit.setOptions readonly state: Accessor>; ``` -Defined in: [async-throttler/createAsyncThrottler.ts:58](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L58) +Defined in: [async-throttler/createAsyncThrottler.ts:64](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L64) Reactive state that will be updated when the throttler state changes @@ -86,7 +86,7 @@ Use this instead of `throttler.store.state` readonly store: Store>>; ``` -Defined in: [async-throttler/createAsyncThrottler.ts:64](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L64) +Defined in: [async-throttler/createAsyncThrottler.ts:70](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L70) #### Deprecated @@ -102,7 +102,7 @@ Although, you can make the state reactive by using the `useSelector` in your own Subscribe: (props) => Element; ``` -Defined in: [async-throttler/createAsyncThrottler.ts:49](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L49) +Defined in: [async-throttler/createAsyncThrottler.ts:55](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L55) A Solid component that allows you to subscribe to the throttler state. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncThrottlerOptions.md b/docs/framework/solid/reference/interfaces/SolidAsyncThrottlerOptions.md index cbb511e0e..f9406c610 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncThrottlerOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncThrottlerOptions.md @@ -3,7 +3,7 @@ id: SolidAsyncThrottlerOptions title: SolidAsyncThrottlerOptions --- -Defined in: [async-throttler/createAsyncThrottler.ts:15](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L15) +Defined in: [async-throttler/createAsyncThrottler.ts:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L21) ## Extends @@ -28,7 +28,7 @@ Defined in: [async-throttler/createAsyncThrottler.ts:15](https://github.com/TanS optional onUnmount?: (throttler) => void; ``` -Defined in: [async-throttler/createAsyncThrottler.ts:23](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L23) +Defined in: [async-throttler/createAsyncThrottler.ts:29](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L29) Optional callback invoked when the owning component unmounts. Receives the throttler instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidBatcher.md b/docs/framework/solid/reference/interfaces/SolidBatcher.md index 5eed41107..aa1631567 100644 --- a/docs/framework/solid/reference/interfaces/SolidBatcher.md +++ b/docs/framework/solid/reference/interfaces/SolidBatcher.md @@ -3,7 +3,7 @@ id: SolidBatcher title: SolidBatcher --- -Defined in: [batcher/createBatcher.ts:22](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L22) +Defined in: [batcher/createBatcher.ts:28](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L28) ## Extends @@ -28,7 +28,7 @@ Defined in: [batcher/createBatcher.ts:22](https://github.com/TanStack/pacer/blob options: Omit>, "initialState" | "key" | "onItemsChange" | "onExecute"> & Partial>, "initialState" | "key" | "onItemsChange" | "onExecute">> & SolidBatcherOptions; ``` -Defined in: [batcher/createBatcher.ts:26](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L26) +Defined in: [batcher/createBatcher.ts:32](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L32) #### Overrides @@ -44,7 +44,7 @@ Omit.options setOptions: (options) => void; ``` -Defined in: [batcher/createBatcher.ts:27](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L27) +Defined in: [batcher/createBatcher.ts:33](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L33) Updates the batcher options @@ -72,7 +72,7 @@ Omit.setOptions readonly state: Accessor>; ``` -Defined in: [batcher/createBatcher.ts:51](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L51) +Defined in: [batcher/createBatcher.ts:57](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L57) Reactive state that will be updated when the batcher state changes @@ -86,7 +86,7 @@ Use this instead of `batcher.store.state` readonly store: Store>>; ``` -Defined in: [batcher/createBatcher.ts:57](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L57) +Defined in: [batcher/createBatcher.ts:63](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L63) #### Deprecated @@ -102,7 +102,7 @@ Although, you can make the state reactive by using the `useSelector` in your own Subscribe: (props) => Element; ``` -Defined in: [batcher/createBatcher.ts:42](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L42) +Defined in: [batcher/createBatcher.ts:48](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L48) A Solid component that allows you to subscribe to the batcher state. diff --git a/docs/framework/solid/reference/interfaces/SolidBatcherOptions.md b/docs/framework/solid/reference/interfaces/SolidBatcherOptions.md index 801b651d1..217642a6f 100644 --- a/docs/framework/solid/reference/interfaces/SolidBatcherOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidBatcherOptions.md @@ -3,7 +3,7 @@ id: SolidBatcherOptions title: SolidBatcherOptions --- -Defined in: [batcher/createBatcher.ts:11](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L11) +Defined in: [batcher/createBatcher.ts:17](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L17) ## Extends @@ -28,7 +28,7 @@ Defined in: [batcher/createBatcher.ts:11](https://github.com/TanStack/pacer/blob optional onUnmount?: (batcher) => void; ``` -Defined in: [batcher/createBatcher.ts:19](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L19) +Defined in: [batcher/createBatcher.ts:25](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L25) Optional callback invoked when the owning component unmounts. Receives the batcher instance. When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidDebouncer.md b/docs/framework/solid/reference/interfaces/SolidDebouncer.md index 214f49f7f..ec7e49283 100644 --- a/docs/framework/solid/reference/interfaces/SolidDebouncer.md +++ b/docs/framework/solid/reference/interfaces/SolidDebouncer.md @@ -3,7 +3,7 @@ id: SolidDebouncer title: SolidDebouncer --- -Defined in: [debouncer/createDebouncer.ts:26](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L26) +Defined in: [debouncer/createDebouncer.ts:32](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L32) ## Extends @@ -28,7 +28,7 @@ Defined in: [debouncer/createDebouncer.ts:26](https://github.com/TanStack/pacer/ options: DebouncerOptions & SolidDebouncerOptions; ``` -Defined in: [debouncer/createDebouncer.ts:30](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L30) +Defined in: [debouncer/createDebouncer.ts:36](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L36) #### Overrides @@ -44,7 +44,7 @@ Omit.options setOptions: (options) => void; ``` -Defined in: [debouncer/createDebouncer.ts:31](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L31) +Defined in: [debouncer/createDebouncer.ts:37](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L37) Updates the debouncer options @@ -72,7 +72,7 @@ Omit.setOptions readonly state: Accessor>; ``` -Defined in: [debouncer/createDebouncer.ts:55](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L55) +Defined in: [debouncer/createDebouncer.ts:61](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L61) Reactive state that will be updated when the debouncer state changes @@ -86,7 +86,7 @@ Use this instead of `debouncer.store.state` readonly store: Store>>; ``` -Defined in: [debouncer/createDebouncer.ts:61](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L61) +Defined in: [debouncer/createDebouncer.ts:67](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L67) #### Deprecated @@ -102,7 +102,7 @@ Although, you can make the state reactive by using the `useSelector` in your own Subscribe: (props) => Element; ``` -Defined in: [debouncer/createDebouncer.ts:46](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L46) +Defined in: [debouncer/createDebouncer.ts:52](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L52) A Solid component that allows you to subscribe to the debouncer state. diff --git a/docs/framework/solid/reference/interfaces/SolidDebouncerOptions.md b/docs/framework/solid/reference/interfaces/SolidDebouncerOptions.md index 95807e250..ef02fa12f 100644 --- a/docs/framework/solid/reference/interfaces/SolidDebouncerOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidDebouncerOptions.md @@ -3,7 +3,7 @@ id: SolidDebouncerOptions title: SolidDebouncerOptions --- -Defined in: [debouncer/createDebouncer.ts:15](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L15) +Defined in: [debouncer/createDebouncer.ts:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L21) ## Extends @@ -28,7 +28,7 @@ Defined in: [debouncer/createDebouncer.ts:15](https://github.com/TanStack/pacer/ optional onUnmount?: (debouncer) => void; ``` -Defined in: [debouncer/createDebouncer.ts:23](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L23) +Defined in: [debouncer/createDebouncer.ts:29](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L29) Optional callback invoked when the owning component unmounts. Receives the debouncer instance. When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidQueuer.md b/docs/framework/solid/reference/interfaces/SolidQueuer.md index beb9131e2..8ac11e731 100644 --- a/docs/framework/solid/reference/interfaces/SolidQueuer.md +++ b/docs/framework/solid/reference/interfaces/SolidQueuer.md @@ -3,7 +3,7 @@ id: SolidQueuer title: SolidQueuer --- -Defined in: [queuer/createQueuer.ts:22](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L22) +Defined in: [queuer/createQueuer.ts:28](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L28) ## Extends @@ -28,7 +28,7 @@ Defined in: [queuer/createQueuer.ts:22](https://github.com/TanStack/pacer/blob/m options: QueuerOptions & SolidQueuerOptions; ``` -Defined in: [queuer/createQueuer.ts:26](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L26) +Defined in: [queuer/createQueuer.ts:32](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L32) #### Overrides @@ -44,7 +44,7 @@ Omit.options setOptions: (options) => void; ``` -Defined in: [queuer/createQueuer.ts:27](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L27) +Defined in: [queuer/createQueuer.ts:33](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L33) Updates the queuer options. New options are merged with existing options. @@ -72,7 +72,7 @@ Omit.setOptions readonly state: Accessor>; ``` -Defined in: [queuer/createQueuer.ts:51](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L51) +Defined in: [queuer/createQueuer.ts:57](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L57) Reactive state that will be updated when the queuer state changes @@ -86,7 +86,7 @@ Use this instead of `queuer.store.state` readonly store: Store>>; ``` -Defined in: [queuer/createQueuer.ts:57](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L57) +Defined in: [queuer/createQueuer.ts:63](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L63) #### Deprecated @@ -102,7 +102,7 @@ Although, you can make the state reactive by using the `useSelector` in your own Subscribe: (props) => Element; ``` -Defined in: [queuer/createQueuer.ts:42](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L42) +Defined in: [queuer/createQueuer.ts:48](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L48) A Solid component that allows you to subscribe to the queuer state. diff --git a/docs/framework/solid/reference/interfaces/SolidQueuerOptions.md b/docs/framework/solid/reference/interfaces/SolidQueuerOptions.md index 4eacace29..119534fdd 100644 --- a/docs/framework/solid/reference/interfaces/SolidQueuerOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidQueuerOptions.md @@ -3,7 +3,7 @@ id: SolidQueuerOptions title: SolidQueuerOptions --- -Defined in: [queuer/createQueuer.ts:11](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L11) +Defined in: [queuer/createQueuer.ts:17](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L17) ## Extends @@ -28,7 +28,7 @@ Defined in: [queuer/createQueuer.ts:11](https://github.com/TanStack/pacer/blob/m optional onUnmount?: (queuer) => void; ``` -Defined in: [queuer/createQueuer.ts:19](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L19) +Defined in: [queuer/createQueuer.ts:25](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L25) Optional callback invoked when the owning component unmounts. Receives the queuer instance. When provided, replaces the default cleanup (stop); use it to call flush(), flushAsBatch(), stop(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidRateLimiter.md b/docs/framework/solid/reference/interfaces/SolidRateLimiter.md index 940520be2..6ab5a8e07 100644 --- a/docs/framework/solid/reference/interfaces/SolidRateLimiter.md +++ b/docs/framework/solid/reference/interfaces/SolidRateLimiter.md @@ -3,7 +3,7 @@ id: SolidRateLimiter title: SolidRateLimiter --- -Defined in: [rate-limiter/createRateLimiter.ts:26](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L26) +Defined in: [rate-limiter/createRateLimiter.ts:32](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L32) ## Extends @@ -28,7 +28,7 @@ Defined in: [rate-limiter/createRateLimiter.ts:26](https://github.com/TanStack/p options: RateLimiterOptions & SolidRateLimiterOptions; ``` -Defined in: [rate-limiter/createRateLimiter.ts:30](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L30) +Defined in: [rate-limiter/createRateLimiter.ts:36](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L36) #### Overrides @@ -44,7 +44,7 @@ Omit.options setOptions: (options) => void; ``` -Defined in: [rate-limiter/createRateLimiter.ts:31](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L31) +Defined in: [rate-limiter/createRateLimiter.ts:37](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L37) Updates the rate limiter options @@ -72,7 +72,7 @@ Omit.setOptions readonly state: Accessor>; ``` -Defined in: [rate-limiter/createRateLimiter.ts:57](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L57) +Defined in: [rate-limiter/createRateLimiter.ts:63](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L63) Reactive state that will be updated when the rate limiter state changes @@ -86,7 +86,7 @@ Use this instead of `rateLimiter.store.state` readonly store: Store>; ``` -Defined in: [rate-limiter/createRateLimiter.ts:63](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L63) +Defined in: [rate-limiter/createRateLimiter.ts:69](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L69) #### Deprecated @@ -102,7 +102,7 @@ Although, you can make the state reactive by using the `useSelector` in your own Subscribe: (props) => Element; ``` -Defined in: [rate-limiter/createRateLimiter.ts:48](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L48) +Defined in: [rate-limiter/createRateLimiter.ts:54](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L54) A Solid component that allows you to subscribe to the rate limiter state. diff --git a/docs/framework/solid/reference/interfaces/SolidRateLimiterOptions.md b/docs/framework/solid/reference/interfaces/SolidRateLimiterOptions.md index abd127ffe..f801e7ba0 100644 --- a/docs/framework/solid/reference/interfaces/SolidRateLimiterOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidRateLimiterOptions.md @@ -3,7 +3,7 @@ id: SolidRateLimiterOptions title: SolidRateLimiterOptions --- -Defined in: [rate-limiter/createRateLimiter.ts:15](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L15) +Defined in: [rate-limiter/createRateLimiter.ts:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L21) ## Extends @@ -28,7 +28,7 @@ Defined in: [rate-limiter/createRateLimiter.ts:15](https://github.com/TanStack/p optional onUnmount?: (rateLimiter) => void; ``` -Defined in: [rate-limiter/createRateLimiter.ts:23](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L23) +Defined in: [rate-limiter/createRateLimiter.ts:29](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L29) Optional callback invoked when the owning component unmounts. Receives the rate limiter instance. When provided, replaces the default cleanup; use it to call reset(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidThrottler.md b/docs/framework/solid/reference/interfaces/SolidThrottler.md index 23f7d1d31..a81c2fdbe 100644 --- a/docs/framework/solid/reference/interfaces/SolidThrottler.md +++ b/docs/framework/solid/reference/interfaces/SolidThrottler.md @@ -3,7 +3,7 @@ id: SolidThrottler title: SolidThrottler --- -Defined in: [throttler/createThrottler.ts:26](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L26) +Defined in: [throttler/createThrottler.ts:32](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L32) ## Extends @@ -28,7 +28,7 @@ Defined in: [throttler/createThrottler.ts:26](https://github.com/TanStack/pacer/ options: ThrottlerOptions & SolidThrottlerOptions; ``` -Defined in: [throttler/createThrottler.ts:30](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L30) +Defined in: [throttler/createThrottler.ts:36](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L36) #### Overrides @@ -44,7 +44,7 @@ Omit.options setOptions: (options) => void; ``` -Defined in: [throttler/createThrottler.ts:31](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L31) +Defined in: [throttler/createThrottler.ts:37](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L37) Updates the throttler options @@ -72,7 +72,7 @@ Omit.setOptions readonly state: Accessor>; ``` -Defined in: [throttler/createThrottler.ts:55](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L55) +Defined in: [throttler/createThrottler.ts:61](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L61) Reactive state that will be updated when the throttler state changes @@ -86,7 +86,7 @@ Use this instead of `throttler.store.state` readonly store: Store>>; ``` -Defined in: [throttler/createThrottler.ts:61](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L61) +Defined in: [throttler/createThrottler.ts:67](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L67) #### Deprecated @@ -102,7 +102,7 @@ Although, you can make the state reactive by using the `useSelector` in your own Subscribe: (props) => Element; ``` -Defined in: [throttler/createThrottler.ts:46](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L46) +Defined in: [throttler/createThrottler.ts:52](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L52) A Solid component that allows you to subscribe to the throttler state. diff --git a/docs/framework/solid/reference/interfaces/SolidThrottlerOptions.md b/docs/framework/solid/reference/interfaces/SolidThrottlerOptions.md index 07063454d..7e7421dfb 100644 --- a/docs/framework/solid/reference/interfaces/SolidThrottlerOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidThrottlerOptions.md @@ -3,7 +3,7 @@ id: SolidThrottlerOptions title: SolidThrottlerOptions --- -Defined in: [throttler/createThrottler.ts:15](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L15) +Defined in: [throttler/createThrottler.ts:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L21) ## Extends @@ -28,7 +28,7 @@ Defined in: [throttler/createThrottler.ts:15](https://github.com/TanStack/pacer/ optional onUnmount?: (throttler) => void; ``` -Defined in: [throttler/createThrottler.ts:23](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L23) +Defined in: [throttler/createThrottler.ts:29](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L29) Optional callback invoked when the owning component unmounts. Receives the throttler instance. When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.