PreactQueuer

Defined in: queuer/useQueuer.ts:20

Extends#

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

Type Parameters#

TValue#

TValue

TSelected#

TSelected = { }

Properties#

state#

readonly state: Readonly<TSelected>;

Defined in: queuer/useQueuer.ts:46

Reactive state that will be updated and re-rendered when the queuer state changes

Use this instead of queuer.store.state

store#

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

Defined in: queuer/useQueuer.ts:52

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 useSelector hook internally. Although, you can make the state reactive by using the useSelector in your own usage.

Subscribe#

Subscribe: <TSelected>(props) => ComponentChildren;

Defined in: queuer/useQueuer.ts:37

A Preact HOC (Higher Order Component) that allows you to subscribe to the queuer state.

This is useful for opting into state re-renders for 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#

ComponentChildren | ((state) => ComponentChildren)

selector#

(state) => TSelected

Returns#

ComponentChildren

Example#

<queuer.Subscribe selector={(state) => ({ size: state.size })}>
  {({ size }) => (
    <div>Queue Size: {size}</div>
  )}
</queuer.Subscribe>