feat: add solid pacer provider and createQueuedSignal hook (#105)

* feat: add solid pacer provider and createQueuedSignal hook

* use default options from solid pacer provider

Author: KevinVandy

.changeset/add-solid-queued-hooks.md

@@ -0,0 +1,8 @@
+---
+'@tanstack/solid-pacer': minor
+---
+
+Add new Solid hooks for queue management and provider
+
+- Add `createQueuedSignal` - Solid equivalent of `useQueuedState` with signal-based queue item tracking
+- Add `PacerProvider` - Context provider for setting default pacer options in Solid apps

docs/config.json

@@ -540,6 +540,10 @@
             {
               "label": "createAsyncQueuer",
               "to": "framework/solid/reference/functions/createAsyncQueuer"
+            },
+            {
+              "label": "createQueuedSignal",
+              "to": "framework/solid/reference/functions/createQueuedSignal"
             }
           ]
         }
@@ -939,6 +943,10 @@
             {
               "label": "createAsyncQueuer",
               "to": "framework/solid/examples/createAsyncQueuer"
+            },
+            {
+              "label": "createQueuedSignal",
+              "to": "framework/solid/examples/createQueuedSignal"
             }
           ]
         }

docs/framework/solid/reference/functions/PacerProvider.md

@@ -0,0 +1,22 @@
+---
+id: PacerProvider
+title: PacerProvider
+---
+
+# Function: PacerProvider()
+
+```ts
+function PacerProvider(props): Element;
+```
+
+Defined in: [solid-pacer/src/provider/PacerProvider.tsx:44](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L44)
+
+## Parameters
+
+### props
+
+[`PacerProviderProps`](../../interfaces/PacerProviderProps.md)
+
+## Returns
+
+`Element`

docs/framework/solid/reference/functions/createAsyncBatcher.md

@@ -8,11 +8,11 @@ title: createAsyncBatcher
 ```ts
 function createAsyncBatcher<TValue, TSelected>(
    fn, 
-   initialOptions, 
+   options, 
 selector): SolidAsyncBatcher<TValue, TSelected>;
 ```
 
-Defined in: [async-batcher/createAsyncBatcher.ts:128](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L128)
+Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:129](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L129)
 
 Creates a Solid-compatible AsyncBatcher instance for managing asynchronous batches of items, exposing Solid signals for all stateful properties.
 
@@ -132,7 +132,7 @@ const { items, isExecuting } = asyncBatcher.state();
 
 (`items`) => `Promise`\<`any`\>
 
-### initialOptions
+### options
 
 `AsyncBatcherOptions`\<`TValue`\> = `{}`
 

docs/framework/solid/reference/functions/createAsyncDebouncer.md

@@ -8,11 +8,11 @@ title: createAsyncDebouncer
 ```ts
 function createAsyncDebouncer<TFn, TSelected>(
    fn, 
-   initialOptions, 
+   options, 
 selector): SolidAsyncDebouncer<TFn, TSelected>;
 ```
 
-Defined in: [async-debouncer/createAsyncDebouncer.ts:118](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L118)
+Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:119](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L119)
 
 A low-level Solid hook that creates an `AsyncDebouncer` instance to delay execution of an async function.
 
@@ -76,7 +76,7 @@ Available state properties:
 
 `TFn`
 
-### initialOptions
+### options
 
 `AsyncDebouncerOptions`\<`TFn`\>
 

docs/framework/solid/reference/functions/createAsyncQueuer.md

@@ -8,11 +8,11 @@ title: createAsyncQueuer
 ```ts
 function createAsyncQueuer<TValue, TSelected>(
    fn, 
-   initialOptions, 
+   options, 
 selector): SolidAsyncQueuer<TValue, TSelected>;
 ```
 
-Defined in: [async-queuer/createAsyncQueuer.ts:120](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L120)
+Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:121](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L121)
 
 Creates a Solid-compatible AsyncQueuer instance for managing an asynchronous queue of items, exposing Solid signals for all stateful properties.
 
@@ -124,7 +124,7 @@ const { pendingItems, activeItems } = asyncQueuer.state();
 
 (`value`) => `Promise`\<`any`\>
 
-### initialOptions
+### options
 
 `AsyncQueuerOptions`\<`TValue`\> = `{}`
 

docs/framework/solid/reference/functions/createAsyncRateLimiter.md

@@ -8,11 +8,11 @@ title: createAsyncRateLimiter
 ```ts
 function createAsyncRateLimiter<TFn, TSelected>(
    fn, 
-   initialOptions, 
+   options, 
 selector): SolidAsyncRateLimiter<TFn, TSelected>;
 ```
 
-Defined in: [async-rate-limiter/createAsyncRateLimiter.ts:129](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L129)
+Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:130](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L130)
 
 A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.
 
@@ -87,7 +87,7 @@ Available state properties:
 
 `TFn`
 
-### initialOptions
+### options
 
 `AsyncRateLimiterOptions`\<`TFn`\>
 

docs/framework/solid/reference/functions/createAsyncThrottler.md

@@ -8,11 +8,11 @@ title: createAsyncThrottler
 ```ts
 function createAsyncThrottler<TFn, TSelected>(
    fn, 
-   initialOptions, 
+   options, 
 selector): SolidAsyncThrottler<TFn, TSelected>;
 ```
 
-Defined in: [async-throttler/createAsyncThrottler.ts:117](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L117)
+Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:118](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L118)
 
 A low-level Solid hook that creates an `AsyncThrottler` instance to limit how often an async function can execute.
 
@@ -76,7 +76,7 @@ Available state properties:
 
 `TFn`
 
-### initialOptions
+### options
 
 `AsyncThrottlerOptions`\<`TFn`\>
 

docs/framework/solid/reference/functions/createBatcher.md

@@ -8,11 +8,11 @@ title: createBatcher
 ```ts
 function createBatcher<TValue, TSelected>(
    fn, 
-   initialOptions, 
+   options, 
 selector): SolidBatcher<TValue, TSelected>;
 ```
 
-Defined in: [batcher/createBatcher.ts:100](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L100)
+Defined in: [solid-pacer/src/batcher/createBatcher.ts:101](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L101)
 
 Creates a Solid-compatible Batcher instance for managing batches of items, exposing Solid signals for all stateful properties.
 
@@ -107,7 +107,7 @@ const { items, isRunning } = batcher.state();
 
 (`items`) => `void`
 
-### initialOptions
+### options
 
 `BatcherOptions`\<`TValue`\> = `{}`
 

docs/framework/solid/reference/functions/createDebouncedSignal.md

@@ -12,7 +12,7 @@ function createDebouncedSignal<TValue, TSelected>(
    selector?): [Accessor<TValue>, Setter<TValue>, SolidDebouncer<Setter<TValue>, TSelected>];
 ```
 
-Defined in: [debouncer/createDebouncedSignal.ts:81](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncedSignal.ts#L81)
+Defined in: [solid-pacer/src/debouncer/createDebouncedSignal.ts:81](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncedSignal.ts#L81)
 
 A Solid hook that creates a debounced state value, combining Solid's createSignal with debouncing functionality.
 This hook provides both the current debounced value and methods to update it.