# fluxible-plugin-react-perf

> A fluxible plugin that runs the React.Perf tools on every `executeAction` and `dispatch`.

Latest version **1.0.0** (published 2016-05-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install fluxible-plugin-react-perf
pnpm add fluxible-plugin-react-perf
yarn add fluxible-plugin-react-perf
bun add fluxible-plugin-react-perf
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-05-25 |
| First published | 2015-06-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Marnus Weststrate |
| Maintainers | marnusw |
| Keywords | fluxible, react, react.Perf, performance, profiling |

## Links

- npm: https://www.npmjs.com/package/fluxible-plugin-react-perf
- Repository: https://github.com/marnusw/fluxible-plugin-react-perf
- Issues: https://github.com/marnusw/fluxible-plugin-react-perf/issues
- npm.io page: https://npm.io/package/fluxible-plugin-react-perf

## Dependencies (1)

- [object-assign](https://npm.io/package/object-assign.md) ^4.0.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2016-05-25
- 0.2.1 — 2015-11-18
- 0.2.0 — 2015-09-29
- 0.1.3 — 2015-09-13
- 0.1.2 — 2015-06-18
- 0.1.1 — 2015-06-13
- 0.1.0 — 2015-06-13

## README

fluxible-plugin-react-perf
==========================

A fluxible plugin that runs the [React.Perf tools](https://facebook.github.io/react/docs/perf.html) 
on every `executeAction` and `dispatch`.

```
npm install fluxible-plugin-react-perf 
```

*Note:* This version requires React.js `>0.14.0-rc1`, to use React `0.13.x`, install version `0.1.3` of this plugin.

## Usage

Simply plug the Plugin into any app to have it print out the `React.Perf` results after any 
`executeAction` and `dispatch` call depending on the provided configuration options.

Since this functionality will typically not be used continuously the plugin can be disabled
without leaving any overhead by providing `options.enabled = false`.

```javascript

import ReactPerfPlugin from 'fluxible-plugin-react-perf';

fluxible.plug(ReactPerfPlugin({
  enabled: true,
  // Overwrite default options
));

```

## Configuration Options and Defaults

Globally enable or disable:

  * **enabled** (`false`): Turn the plugin on or off in its entirety.

Enable/disable the various `React.Perf` outputs:
  
  * **printInclusive** (`true`): Enable/Disable printing the [Perf.printInclusive](https://facebook.github.io/react/docs/perf.html#perf.printinclusivemeasurements) measurements.
  * **printExclusive** (`false`): Enable/Disable printing the [Perf.printExclusive](https://facebook.github.io/react/docs/perf.html#perf.printexclusivemeasurements) measurements.
  * **printWasted** (`true`): Enable/Disable printing the [Perf.printWasted](https://facebook.github.io/react/docs/perf.html#perf.printwastedmeasurements) measurements.
  * **printDOM** (`false`): Enable/Disable printing the [Perf.printDOM](https://facebook.github.io/react/docs/perf.html#perf.printdommeasurements) measurements.

Print the duration of the actions and dispatches themselves:

  * **printActionDuration** (`true`): Print the time elapsed from a call to executeAction until its `done` method is called or `Promise` resolved. 
  * **printDispatchDuration** (`true`): Print the time it takes to execute a `dispatch` from within an action creator.

Make the output even more verbose for further debugging:
  
  * **verbose** (`true`): Print a notice whenever an action or dispatch starts executing, useful when debugging to see where things fail. 
  * **printActionPayload** (`false`): If `verbose` mode is enabled this will also print the payload provided to all executed actions.

## License

This software is free to use under the MIT license.
See the [LICENSE file](LICENSE.md) for license text and copyright information.

---
_Source: https://npm.io/package/fluxible-plugin-react-perf · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._