Framework
Version
Debouncer API Reference
Throttler API Reference
Rate Limiter API Reference
Queue API Reference
Batcher API Reference

SolidQueuer

Interface: SolidQueuer<TValue, TSelected>

Defined in: solid-pacer/src/queuer/createQueuer.ts:8

Extends

  • Omit<Queuer<TValue>, "store">

Type Parameters

TValue

TValue

TSelected

TSelected = { }

Properties

state

ts
readonly state: Accessor<Readonly<TSelected>>;
readonly state: Accessor<Readonly<TSelected>>;

Defined in: solid-pacer/src/queuer/createQueuer.ts:34

Reactive state that will be updated when the queuer state changes

Use this instead of queuer.store.state


store

ts
readonly store: Store<Readonly<QueuerState<TValue>>>;
readonly store: Store<Readonly<QueuerState<TValue>>>;

Defined in: solid-pacer/src/queuer/createQueuer.ts:40

Deprecated

Use queuer.state instead of queuer.store.state if you want to read reactive state. The state on the store object is not reactive, as it has not been wrapped in a useStore hook internally. Although, you can make the state reactive by using the useStore in your own usage.


Subscribe()

ts
Subscribe: <TSelected>(props) => Element;
Subscribe: <TSelected>(props) => Element;

Defined in: solid-pacer/src/queuer/createQueuer.ts:25

A Solid component that allows you to subscribe to the queuer state.

This is useful for tracking specific parts of the queuer state deep in your component tree without needing to pass a selector to the hook.

Type Parameters

TSelected

TSelected

Parameters

props
children

Element | (state) => Element

selector

(state) => TSelected

Returns

Element

Example

ts
<queuer.Subscribe selector={(state) => ({ size: state.size, isRunning: state.isRunning })}>
  {(state) => (
    <div>Queue: {state().size} items, {state().isRunning ? 'Processing' : 'Idle'}</div>
  )}
</queuer.Subscribe>
<queuer.Subscribe selector={(state) => ({ size: state.size, isRunning: state.isRunning })}>
  {(state) => (
    <div>Queue: {state().size} items, {state().isRunning ? 'Processing' : 'Idle'}</div>
  )}
</queuer.Subscribe>