statelyai/xstate v4.5.0

on GitHub

• 📬 Sending events with payloads to running services just got a lot easier. You can now specify two arguments:
  • eventType (string)
  • payload (object)

service.send('EVENT', { foo: 'bar' });

// equivalent to...
service.send({ type: 'EVENT', foo: 'bar' });

This is similar to how Vuex allows you to send events. #408

• ➕ You can now send batch events in a running service:

someService.send([
  'SOME_EVENT', // simple events
  'ANOTHER_EVENT',
  { type: 'YET_ANOTHER_EVENT', data: [1, 2, 3] } // event objects
]);

Actions from each state will be bound to a snapshot of their state at the time of their creation, and execution is deferred until all events are processed (in essentially zero-time). #409

• 🚪 To avoid confusion, onEntry and onExit have been aliased to entry and exit, respectively:

// ...
{
- onEntry: 'doSomething',
+ entry: 'doSomething',
- onExit: 'doSomethingElse',
+ exit: 'doSomethingElse'
}

The onEntry and onExit properties still work, and are not deprecated in this major version.

• 🗺 Instead of just true or false for the activities mapping in State objects, a truthy activity actually gives you the full activity definition.
• ⏱ Proper scheduler work eliminates many edge-cases and issues with sync/async event processing, thanks to @jjkola #392
• 🤐 Thanks to @johnyanarella, invoking promises will work with promise-like values in case non-native promises are used. #415 #417
• 👩‍🏫 The Interpreter class is exposed in the main exports.
• 🆕 New package: @xstate/immer coming soon! More info on this 🔜

Docs

• ✍️ In the examples, ctx is spelled out to context and e to event in order to improve readability and comprehension.
• 🔭 The RxJS docs 📖 were updated to address #339
• 🚚 The internal transition docs moved into the transitions docs 📖.
• ℹ️ New pages: About 📖 and Goals 📖 (more to be added 🔜)
• 🔘 Docs were added for relative targets (shortcut syntax) in ids 📖 and transitions 📖
• ⏪ Docs on restarting activities 📖 were added
• 🕵️‍♀️ The options argument was missing in the useMachine implementation in the React docs 📖 - that's been fixed 😅