npmpackage.info

Gathering detailed insights and metrics for @cromwellian/redux-promise-middleware-actions

@cromwellian/redux-promise-middleware-actions - 2.1.1 | npmpackage.info

@cromwellian/redux-promise-middleware-actions

Redux action creator for making async actions compatible with redux-promise-middleware

2.1.1

MIT

TypeScript

645.00 B

839 1.7

Installations

npm install @cromwellian/redux-promise-middleware-actions

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

10.13.0

NPM Version

6.4.1 Score

71.8

Supply Chain

99.3

Quality

75.1

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

TypeScript

TypeScript (100%)

Developer

cromwellian

Download Statistics

Total Downloads

839

Last Day

Last Week

Last Month

Last Year

137

GitHub Statistics

MIT License

12 Commits

2 Watchers

4 Branches

1 Contributors

Updated on Nov 12, 2018

Bundle Size

1.57 kB

Minified

645.00 B

Minified + Gzipped

Bundlephobia

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

2.1.1

Package Id

@cromwellian/redux-promise-middleware-actions@2.1.1

Unpacked Size

26.58 kB

Size

7.32 kB

File Count

NPM Version

6.4.1

Node Version

10.13.0

Total Downloads

Cumulative downloads

Total Downloads

839

Last Day

Compared to previous day

Last Week

100%

Compared to previous week

Last Month

-55.2%

Compared to previous month

Last Year

4.6%

137

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@types/mocha @types/node mocha nyc ts-node tslint typescript

redux-promise-middleware-actions

Create Redux actions with a type and payload in a standardized way. Inspired by redux-actions but simpler and with special support for asynchronous actions (promises).

Has no dependencies and is tiny (~680 bytes gzipped). First class TypeScript support.

Works with redux-promise-middleware to handle asynchronous actions by dispatching pending, fulfilled and rejected events based on the state of the input promise.

Goals of this library:

Reference action creators directly - no need to maintain an action type enum/list
Automatically generate actions for pending, fulfilled and rejected outcomes of a promise payload
Have statically typed access to all action types - no need to manually add a type suffix like "_PENDING"
TypeScript support so asynchronous actions can't be confused for normal synchronous actions

Note: If you are using TypeScript this library requires TypeScript 3. For TypeScript 2 use version 1 of this library.

Installation

You need to install this library as well as redux-promise-middleware.

npm install redux-promise-middleware-actions redux-promise-middleware

Include redux-promise-middleware when you create your store:

1import promiseMiddleware from 'redux-promise-middleware';
2
3composeStoreWithMiddleware = applyMiddleware(
4  promiseMiddleware(),
5)(createStore);

Usage

Synchronous action

Synchronous actions works exactly like redux-actions. You supply a function that returns whatever payload the action should have (if any).

1import { createAction } from 'redux-promise-middleware-actions';
2
3export const foo = createAction('FOO', (num) => num);
4
5dispatch(foo(5)); // { type: 'FOO', payload: 5 }

When handling the action in a reducer, you simply cast the action function to a string to return the type. This ensures type safety (no spelling errors) and you can use code navigation to find all uses of an action.

1const fooType = String(foo); // 'FOO'

Asynchronous action

When you create an asynchronous action you need to return a promise payload. If your action is called FOO the following events will be dispatched:

FOO_PENDING is dispatched immediately
FOO_FULFILLED is dispatched when the promise is resolved
- ... or FOO_REJECTED is dispatched instead if the promise is rejected

1import { createAsyncAction } from 'redux-promise-middleware-actions';
2
3export const fetchData = createAsyncAction('FETCH_DATA', async () => {
4  const res = await fetch(...);
5  return res.json();
6});
7
8dispatch(fetchData()); // { type: 'FETCH_DATA_PENDING' }

An async action function has three properties to access the possible outcome actions: pending, fulfilled and rejected. You can dispatch them directly (in tests etc.):

1dispatch(fetchData.pending());          // { type: 'FETCH_DATA_PENDING' }
2dispacth(fetchData.fulfilled(payload)); // { type: 'FETCH_DATA_FULFILLED', payload: ... }
3dispacth(fetchData.rejected(err));      // { type: 'FETCH_DATA_REJECTED', payload: err, error: true }

But normally you only need them when you are writing reducers:

1case String(fetchData.pending):   // 'FETCH_DATA_PENDING'
2case String(fetchData.fulfilled): // 'FETCH_DATA_FULFILLED'
3case String(fetchData.rejected):  // 'FETCH_DATA_REJECTED'

Note that if you try and use the base function in a reducer, an error will be thrown to ensure you are not listening for an action that will never happen:

1case String(fetchData): // throws an error

Async reducer

You can now handle the different events in your reducer by referencing the possible outcome states:

1import { fetchData } from './actions';
2
3export default (state, action) => {
4  switch (action.type) {
5    case String(fetchData.pending):
6      return {
7        ...state,
8        pending: true,
9      };
10    case String(fetchData.fulfilled):
11      return {
12        ...state,
13        data: action.payload,
14        error: undefined,
15        pending: false,
16      };
17    case String(fetchData.rejected):
18      return {
19        ...state,
20        error: action.payload,
21        pending: false,
22      };
23    default:
24      return state;
25  }
26};

Async reducer helper

It can get tedious writing the same reducer for every single async action so we've included a simple reducer that does the same as the example above:

1import { asyncReducer } from 'redux-promise-middleware-actions';
2import { fetchData } from './actions';
3
4export default asyncReducer(fetchData);

You can also combine it with an existing reducer:

1import { asyncReducer } from 'redux-promise-middleware-actions';
2import { fetchData } from './actions';
3
4const fetchReducer = asyncReducer(fetchData);
5
6export default (state, action) => {
7  const newState = fetchReducer(state, action);
8
9  switch (action.type) {
10    case 'SOME_OTHER_ACTION':
11      return { ... };
12    default:
13      return newState;
14  }
15};

Metadata

You can add metadata to any action by supplying an additional metadata creator function. The metadata creator will receive the same arguments as the payload creator:

`createAction(type, payloadCreator, metadataCreator)`

1export const foo = createAction(
2  'FOO',
3  (num) => num,
4  (num) => num + num
5);
6
7dispatch(foo(5)); // { type: 'FOO', meta: 10, payload: 5 }

`createAsyncAction(type, payloadCreator, metadataCreator)`

1export const fetchData = createAsyncAction(
2  'FETCH_DATA',
3  (n: number) => fetch(...),
4  (n: number) => ({ n })
5);
6
7dispatch(fetchData(42));
8// { type: 'FETCH_DATA_PENDING', meta: { n: 42 } }
9// { type: 'FETCH_DATA_FULFILLED', meta: { n: 42 }, payload: Promise<...> }
10// { type: 'FETCH_DATA_REJECTED', meta: { n: 42 }, payload: Error(...) }

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-06-16

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More