zustand

🐻 Bear necessities for state management in React

Install

bash
Copy
npm install zustand

Install these too only if you use what needs them: @types/react, immer, react, use-sync-external-store.

Functions

useStore

ts
Copy
function useStore<S extends ReadonlyStoreApi<unknown>>(
  api: S,
): ExtractState<S>
function useStore<S extends ReadonlyStoreApi<unknown>, U>(
  api: S,
  selector: (state: ExtractState<S>) => U,
): U

Constants

create

ts
Copy
const create: Create

createStore

ts
Copy
const createStore: CreateStore

Interfaces

StoreApi

ts
Copy
interface StoreApi<T>

Properties

StoreMutators

Also has every member of StoreMutators, listed on its own entry.

ts
Copy
interface StoreMutators<S, A>

Types

ExtractState

ts
Copy
type ExtractState<S> = S extends { getState: () => infer T } ? T : never

Mutate

ts
Copy
type Mutate<S, Ms> = number extends Ms['length' & keyof Ms]
  ? S
  : Ms extends []
    ? S
    : Ms extends [[infer Mi, infer Ma], ...infer Mrs]
      ? Mutate<StoreMutators<S, Ma>[Mi & StoreMutatorIdentifier], Mrs>
      : never

StateCreator

ts
Copy
type StateCreator<
  T,
  Mis extends [StoreMutatorIdentifier, unknown][] = [],
  Mos extends [StoreMutatorIdentifier, unknown][] = [],
  U = T,
> = ((
  setState: Get<Mutate<StoreApi<T>, Mis>, 'setState', never>,
  getState: Get<Mutate<StoreApi<T>, Mis>, 'getState', never>,
  store: Mutate<StoreApi<T>, Mis>,
) => U) & { $$storeMutators?: Mos }

Properties

StoreMutatorIdentifier

Also has every member of String, listed on its own entry.

ts
Copy
type StoreMutatorIdentifier = keyof StoreMutators<unknown, unknown>

UseBoundStore

Also has every member of StoreApi, listed on its own entry.

ts
Copy
type UseBoundStore<S extends ReadonlyStoreApi<unknown>> = {
  (): ExtractState<S>
  <U>(selector: (state: ExtractState<S>) => U): U
} & S