Skip to content

Installation

To install Alette Signal, run the following command in your terminal:

sh
pnpm add @alette/signal@latest
sh
npm install @alette/signal@latest
sh
yarn add @alette/signal@latest

INFO

Requirements:

  1. TypeScript 5.4 or newer.
  2. Environment supporting structuredClone. WebWorkers support structuredClone() out of the box, while a polyfill is needed for old browsers.

Recommendations:

  1. Use Biome instead of Eslint for linting and formatting due to speed.

Usage with UI frameworks

To use Alette Signal with UI frameworks, refer to the framework integration guides:

  1. React integration guide.

Usage with state managers

To use Alette Signal with a state manager, refer to the state manager integration guides:

  1. Redux integration guide.

Released under the Apache 2.0 License.