Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/solid-pacer-subscribe-reactivity.md
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ function createAsyncBatcher<TValue, TSelected>(
selector?): SolidAsyncBatcher<TValue, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ function createAsyncDebouncer<TFn, TSelected>(
selector?): SolidAsyncDebouncer<TFn, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ function createAsyncQueuer<TValue, TSelected>(
selector?): SolidAsyncQueuer<TValue, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ function createAsyncRateLimiter<TFn, TSelected>(
selector?): SolidAsyncRateLimiter<TFn, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ function createAsyncThrottler<TFn, TSelected>(
selector?): SolidAsyncThrottler<TFn, TSelected>;
```

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.

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/solid/reference/functions/createBatcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ function createBatcher<TValue, TSelected>(
selector?): SolidBatcher<TValue, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ function createDebouncer<TFn, TSelected>(
selector?): SolidDebouncer<TFn, TSelected>;
```

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.

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/solid/reference/functions/createQueuer.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ function createQueuer<TValue, TSelected>(
selector?): SolidQueuer<TValue, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ function createRateLimiter<TFn, TSelected>(
selector?): SolidRateLimiter<TFn, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ function createThrottler<TFn, TSelected>(
selector?): SolidThrottler<TFn, TSelected>;
```

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.

Expand Down
12 changes: 6 additions & 6 deletions docs/framework/solid/reference/interfaces/SolidAsyncBatcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -40,7 +40,7 @@ options: Omit<Required<AsyncBatcherOptions<TValue>>,
| "onItemsChange">> & SolidAsyncBatcherOptions<TValue, TSelected>;
```

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

Expand All @@ -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

Expand Down Expand Up @@ -84,7 +84,7 @@ Omit.setOptions
readonly state: Accessor<Readonly<TSelected>>;
```

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

Expand All @@ -98,7 +98,7 @@ Use this instead of `batcher.store.state`
readonly store: Store<Readonly<AsyncBatcherState<TValue>>>;
```

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

Expand All @@ -114,7 +114,7 @@ Although, you can make the state reactive by using the `useSelector` in your own
Subscribe: <TSelected>(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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions docs/framework/solid/reference/interfaces/SolidAsyncDebouncer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -28,7 +28,7 @@ Defined in: [async-debouncer/createAsyncDebouncer.ts:26](https://github.com/TanS
options: AsyncDebouncerOptions<TFn> & SolidAsyncDebouncerOptions<TFn, TSelected>;
```

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

Expand All @@ -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

Expand Down Expand Up @@ -72,7 +72,7 @@ Omit.setOptions
readonly state: Accessor<Readonly<TSelected>>;
```

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

Expand All @@ -86,7 +86,7 @@ Use this instead of `debouncer.store.state`
readonly store: Store<Readonly<AsyncDebouncerState<TFn>>>;
```

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

Expand All @@ -102,7 +102,7 @@ Although, you can make the state reactive by using the `useSelector` in your own
Subscribe: <TSelected>(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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions docs/framework/solid/reference/interfaces/SolidAsyncQueuer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -28,7 +28,7 @@ Defined in: [async-queuer/createAsyncQueuer.ts:25](https://github.com/TanStack/p
options: AsyncQueuerOptions<TValue> & SolidAsyncQueuerOptions<TValue, TSelected>;
```

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

Expand All @@ -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.

Expand Down Expand Up @@ -72,7 +72,7 @@ Omit.setOptions
readonly state: Accessor<Readonly<TSelected>>;
```

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

Expand All @@ -86,7 +86,7 @@ Use this instead of `queuer.store.state`
readonly store: Store<Readonly<AsyncQueuerState<TValue>>>;
```

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

Expand All @@ -102,7 +102,7 @@ Although, you can make the state reactive by using the `useSelector` in your own
Subscribe: <TSelected>(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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down
Loading
Loading