Skip to main content

Defining Actions

In Retomus, actions are named events that trigger transitions between statuses.
They can optionally carry a payload and invoke logic via an action handler.

📌 What is an Action?​

An action is a string identifier for an event your machine can respond to.

const actions = ['increment', 'decrement', 'reset'];

Each action maps to:

  • A transition (status change)
  • A handler (side effect logic)
  • Optional payload

🧪 Good Practices for Action Naming​

  • Use verbs (increment, fetch, submit)
  • Be declarative, not imperative (toggle vs doToggleNow)
  • Use snake_case or camelCase consistently

💡 Tip: Keep action names flat​

// ✅ Good
const actions = ['start', 'stop', 'reset'];

// ❌ Bad (deep nesting not supported)
const actions = {
  start: true,
  stop: true,
};