# [React Retux](https://github.com/crimx/retux/tree/master/packages/react-retux)

[![npm-version](https://img.shields.io/npm/v/react-retux.svg)](https://www.npmjs.com/package/react-retux)
[![npm bundle size](https://img.shields.io/bundlephobia/minzip/react-retux)](https://bundlephobia.com/result?p=react-retux)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?maxAge=2592000)](http://commitizen.github.io/cz-cli/)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-brightgreen.svg?maxAge=2592000)](https://conventionalcommits.org)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

React-Redux Type enhancement suite.

## Features

- Better intellisense auto-complete and error code highlight.
- Prevent duplicated keys on mapState and mapDispatch.
- Easy to work with mixed action types(Thunk, Promise...).
- Designed for Retux architecture but can be used in any project directly.

## Installation

- yarn: `yarn add react-retux`
- npm: `npm add react-retux`

## Usage

See [official guide](https://retux.js.org/guide/react-retux.html).

## API

All typings no JavaScript code.

See [docs](https://retux.js.org/api/react-retux.html).

## Examples

See [Tests](https://github.com/crimx/retux/tree/master/packages/react-retux/__tests__) and [Retux Examples](https://github.com/crimx/retux/tree/master/examples), especially [thunk-promise-example](https://github.com/crimx/retux/tree/master/examplesthunk-promise-example).