State API reference

@kitr/state re-exports everything from zustand and adds createKitrStore.

createKitrStore

function createKitrStore<T extends object>(
  options: KitrStoreOptions<T>,
  initializer: StateCreator<T>,
): readonly [useStore, StoreProvider, store]

Creates a store that is a singleton in the browser and per-provider on the server.

Options

Option	Type	Default	Description
`name`	`string`	required	Used for devtools and as the storage key `kitr:<name>`.
`persist`	`boolean \| PersistOptions`	`false`	Save to `localStorage`. An object is passed to Zustand's `persist` middleware; its `name` overrides the storage key.
`devtools`	`boolean`	`true` in dev	Connect to Redux DevTools in development.
`strict`	`boolean`	`false`	Throw on the server when the hook runs outside a `StoreProvider`.

Returns

A tuple. Name the parts whatever suits your store.

Position	Value	Description
0	`useStore()` / `useStore(selector)`	Hook. Without a selector it returns the whole state.
1	`StoreProvider`	Component with `children` and optional `initialState: Partial<T>`. Shares one store per server render.
2	`store`	The browser's `StoreApi<T>`, or `null` on the server.

Errors

Without a surrounding StoreProvider, the hook on the server reads a fresh store of the component's own, built from the initial state. With strict: true it throws instead:

[@kitr/state] Store "cart" has no instance on the server. Wrap the tree in its <StoreProvider>.

Re-exports from zustand

create, createStore, useStore, StateCreator, StoreApi and everything else Zustand exports. Middleware such as persist, devtools and createJSONStorage comes from zustand/middleware.