declareStore

Callable

• declareStore<State, Updates>(storeOptions: Readonly<{ initialState: State; options?: AtomOptions<State>; updates: Updates }>): StoreFactory<State, Updates>

---

• declare the base interface for create store

  @example

  type State = {
   id: string;
   name: string;
   isAdmin: boolean
  };
  const initialState: State = {
   id: '',
   name: '',
   isAdmin: false
  };
  const createUserStore = declareStore({
   initialState,
   updates: {
     setId: (id: string) => (state) => {
       return {
         ...state,
         id: id,
       };
     },
     setName: (name: string) => (state) => {
       return {
         ...state,
         name: name,
       };
     },
     update: (id: string name: string) => (state) => {
       return {
         ...state,
         id: id,
         name: name,
       };
     },
     setIsAdmin: () => (state) => {
       return {
         ...state,
         isAdmin: true,
       };
     },
   },
  });
  
  const userStore1 = createUserStore({ id: '1', name: 'User 1', isAdmin: false });
  
  const userStore2 = createUserStore({ id: '2', name: 'User 2', isAdmin: true });
  
  // OR
  
  const users = [
   createUserStore({id: 1, name: 'User 1'}),
   createUserStore({id: 2, name: 'User 2'}),
  ]
  
  userStore1.updates.setName('User from store 1');
  
  assets.isEqual(userStore1.get().name, 'User from store 1')
  
  assets.isEqual(userStore2.get().name, 'User 2')
  
  // type of createUserStore
  type UserStore = ReturnType<typeof createUserStore>;

  ---

  Type parameters

  • State
  • Updates: Readonly<Record<string, (...args: any[]) => StateMutation<State>>> = Readonly<Record<string, (...args: any[]) => StateMutation<State>>>

  Parameters

  • storeOptions: Readonly<{ initialState: State; options?: AtomOptions<State>; updates: Updates }>

  Returns StoreFactory<State, Updates>