add `EventFromStore` utility type to `@xstate/store`

statelyai / xstate

Actor-based state management & orchestration for complex app logic.

MIT License

27.21k stars 1.26k forks source link

This PR adds the EventFromStore utility type to @xstate/store. EventFromStore allows us to extract the type of events from a given store:

import { createStore, type EventFromStore } from '@xstate/store';

const store = createStore(
  { count: 0 },
  {
    add: (context, event: { addend: number }) => ({
      count: context.count + event.addend
    }),
    multiply: (context, event: { multiplier: number }) => ({
      count: context.count * event.multiplier
    })
  }
);

type StoreEvent = EventFromStore<typeof store>;
//   ^? { type: 'add'; addend: number } | { type: 'multiply'; multiplier: number }

This idea came about thanks to @qiushiyan in #5017.

statelyai / xstate

add `EventFromStore` utility type to `@xstate/store` #5020

🦋 Changeset detected