Function createStore

Creates a store with an initial state and actions that can modify the state.

Example

import { createStore } from "@fransek/statekit";

const store = createStore({ count: 0 }, (set) => ({
  increment: () => set((state) => ({ count: state.count + 1 })),
  decrement: () => set((state) => ({ count: state.count - 1 })),
  reset: () => set({ count: 0 }),
}));

createStore<
    TState extends object,
    TActions extends object = Record<never, never>,
>(
    initialState: TState,
    defineActions?: null | DefineActions<TState, TActions>,
    options?: StoreOptions<TState>,
): Store<TState, TActions>
Type Parameters
- TState extends object
- TActions extends object = Record<never, never>
Parameters
- initialState: TState
  The initial state of the store.
- OptionaldefineActions: null | DefineActions<TState, TActions> = null
  A function that defines actions that can modify the state.
- Optionaloptions: StoreOptions<TState> = {}
  Additional options for the store.
Returns Store<TState, TActions>
The created store with state management methods.
- Defined in core/createStore.ts:68

Function createStore

Example

Type Parameters

Parameters

Returns Store<TState, TActions>

Settings