React/Flux Constants

NOTE

If you installed this package using npm install react-constants please be aware that this package has been renamed to flux-constants and should instead be installed with npm install flux-constants if you want the latest version and updates over time.

So what is this thing?

A bit 'o sugar for those looking to quickly create Flux style constants.

Installation:

Two options:

Option 1: npm

npm install --save flux-constants

Option 2: clone

git clone https://github.com/boichee/flux-constants

Having used React + Flux and typed this far too many times:

// ComponentConstants.js
var keyMirror = require('key-mirror');

module.exports = keyMirror({
  "SOME_CONSTANT": null,
  "ANOTHER_CONSTANT": null
});

I decided I hated having to type null over and over again for no reason.

So, I created this module as an alternative. Now you can do:

// ComponentConstants.js
module.exports = require('flux-constants')([
  "SOME_CONSTANT",
  "ANOTHER_CONSTANT"
]);

Ultimately, the result is the same: A JS object that looks like this: { SOME_CONSTANT: "SOME_CONSTANT", ANOTHER_CONSTANT: "ANOTHER_CONSTANT" }

Usage:

First, create your Flux Constants file:

SomeFluxConstants.js

module.exports = require('flux-constants')([
  'MY_FIRST_CONSTANT',
  'MY_SECOND_CONSTANT'
]);

Then use the constants like this:

SomeFluxActionCreator.js

var ComponentConstants = require('../constants/ComponentConstants')

var FluxActions = {
  doSomethingFluxLike: function(data) {
    var action = {
      type: ComponentConstants.MY_FIRST_CONSTANT,
      data: data
    };
    
    AtlasDispatcher.handleAction(action);
  }
};

Enjoy!