Skip to content

kettil/react-fluxrx

Repository files navigation

react-fluxRx [BETA]

❗❗ IMPORTANT ❗❗

The library is still in the BETA. The structure and functions or their parameters can still change.

react-fluxRx is a predictable state container for react apps. It combines the idea behind flux/redux and RxJS.

Table of Contents

Features

  • Support one or many state containers
  • Actions can synchronously or asynchronously
  • Multiple updates can be made per action
  • API similar to redux (e.g. you can use reselect)
  • Simple integration of e.g. debounce or throttle per action
  • Middleware system
  • Full TypeScript support
  • Support for Redux DevTools

Installation

npm install -P react-fluxrx

Introduction

A description of all modules and the API can be found under Documents.

In the example folder there are two example projects, one a simple application and one with AJAX.

It is best to clone the project and enter the following command in the corresponding example folder:

npm i && npm start

Building

Compile the application from TypeScript to JavaScript.

The following command is available:

  • npm run build

    Builds the application

Tests

The following commands are available:

Command Description
npm run test Run all unit tests
npm run test:watch Watching mode from unit test
npm run coverage Creates a coverage report from test

Prettier and Lint

Ensures that the code is formatted uniformly and that the coding standards are adhered to.

The following commands are available:

  • npm run prettier

    Changes the code formatting as defined in the Prettier setting.

  • npm run lint

    Checks if the lint rules are followed. It calls the prettier command first.