https://github.com/versent/action-names
Standard Action names for Flux
https://github.com/versent/action-names
Last synced: about 1 year ago
JSON representation
Standard Action names for Flux
- Host: GitHub
- URL: https://github.com/versent/action-names
- Owner: Versent
- Created: 2015-08-18T00:01:11.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-09-27T09:49:48.000Z (almost 9 years ago)
- Last Synced: 2025-04-19T17:18:42.555Z (about 1 year ago)
- Language: JavaScript
- Size: 9.77 KB
- Stars: 5
- Watchers: 10
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Standard Action Names for Flux
[ ](https://codeship.com/projects/97650)
## Install
```
npm install action-names --save-dev
```
## Usage
```
var actionNames = require('action-names');
var names = actionNames('users');
```
`names` will contain an object:
```
{
USERS_FETCH_START: 'USERS_FETCH_START',
USERS_FETCH_SUCCESS: 'USERS_FETCH_SUCCESS',
USERS_FETCH_ERROR: 'USERS_FETCH_ERROR',
USERS_UPDATE_START: 'USERS_UPDATE_START',
USERS_UPDATE_SUCCESS: 'USERS_UPDATE_SUCCESS',
USERS_UPDATE_ERROR: 'USERS_UPDATE_ERROR',
USERS_CREATE_START: 'USERS_CREATE_START',
USERS_CREATE_SUCCESS: 'USERS_CREATE_SUCCESS',
USERS_CREATE_ERROR: 'USERS_CREATE_ERROR',
USERS_DELETE_START: 'USERS_DELETE_START',
USERS_DELETE_SUCCESS: 'USERS_DELETE_SUCCESS',
USERS_DELETE_ERROR: 'USERS_DELETE_ERROR',
// Object also contains aliases
fetchStart: 'USERS_FETCH_START',
fetchSuccess: 'USERS_FETCH_SUCCESS',
fetchError: 'USERS_FETCH_ERROR',
updateStart: 'USERS_UPDATE_START',
updateSuccess: 'USERS_UPDATE_SUCCESS',
updateError: 'USERS_UPDATE_ERROR',
createStart: 'USERS_CREATE_START',
createSuccess: 'USERS_CREATE_SUCCESS',
createError: 'USERS_CREATE_ERROR',
deleteStart: 'USERS_DELETE_START',
deleteSuccess: 'USERS_DELETE_SUCCESS',
deleteError: 'USERS_DELETE_ERROR',
}
```
## Config
This modules takes a second argument:
```js
var names = actionNames('users', config);
```
`config` is an object with the following options:
`config.addAlias` [true] adds the action aliases e.g. `fetchStart`
## Test
```
npm i
npm test
```