Skip to main content

Installation

To get started with Retomus, install the core library:

npm install retomus

or if you prefer Yarn:

yarn add retomus

✅ What You Get​

The main package includes:

  • Core state machine engine
  • React integration (hooks, wrapper)
  • TypeScript support

💡 Recommended Setup​

Retomus works out of the box in React projects using:

  • React 17+
  • TypeScript 4.0+
  • Modern bundlers like Vite, Webpack, Next.js, etc.

🔧 TypeScript Typings​

Retomus is written in TypeScript and provides full typings by default — no need for additional @types packages.

🧪 Peer Dependencies​

None. Retomus is a zero-dependency library except for React.