npmpackage.info

Gathering detailed insights and metrics for redux-pender

Other packages similar to redux-pender

react-redux-pender

0.1.0

react-redux-pender

vuex-pender

1.0.2

vuex-pender inspired by velopert/redux-pender

vuex-action-pender

0.5.0

vuex-action-pender for async work inspired by velopert/redux-pender

Gathering detailed insights and metrics for redux-pender

redux-pender - 2.0.12 | npmpackage.info

redux-pender

redux middleware that helps to manages async actions based on promise

2.0.12

101

MIT

JavaScript

2.59 kB

183,327 1.7

Installations

npm install redux-pender

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Score

72.3

Supply Chain

98.8

Quality

76.1

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

33

Total

42

Closed

9

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

TypeScript

JavaScript (50.2%)

TypeScript (49.8%)

Developer

velopert

Download Statistics

Total Downloads

183,327

Last Day

Last Week

359

Last Month

1,735

Last Year

25,855

GitHub Statistics

MIT License

101 Stars

86 Commits

7 Forks

7 Watchers

36 Branches

1 Contributors

Updated on Jun 13, 2024

Bundle Size

6.98 kB

Minified

2.59 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

2.0.12

Package Id

redux-pender@2.0.12

Unpacked Size

22.91 kB

Size

6.90 kB

File Count

Total Downloads

Cumulative downloads

Total Downloads

183,327

Last Day

-14.3%

Compared to previous day

Last Week

-33.1%

359

Compared to previous week

Last Month

-25.4%

1,735

Compared to previous month

Last Year

11.6%

25,855

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

proxy-polyfill

Dev Dependencies

@types/redux-actions babel-cli babel-preset-es2015 babel-preset-stage-0 eslint eslint-config-airbnb-base eslint-plugin-import eslint-plugin-jest jest prettier-eslint redux redux-actions tslint-config-airbnb tslint-config-prettier typescript

redux-pender

Introduction

Redux pender is a middleware that helps you to manage asynchronous actions based on promise. It comes with useful tools that help you to handle this even more easier.

This library is inspired from redux-promise-middleware. The difference between redux-promise-middleware and this library is that this comes with some handy utils. Additionally, it also handles the cancellation of the promise-based action. To check out detailed comparisons between other libraries, please check Comparisons document

Installation

1npm i --save redux-pender

Usage

Configure Store

1import { applyMiddleware, createStore, combineReducers } from 'redux';
2import penderMiddleware, { penderReducer } from 'redux-pender';
3
4const reducers = {
5    /*
6        ...your other reducers...
7    */
8    pender: penderReducer
9};
10
11const store = createStore(
12    reducers,
13    applyMiddleware(penderMiddleware())
14);

penderReducer is the reducer that tracks the status of your asynchronous actions.

When your request is pending, store.getState().pender.pending[ACTION_NAME] will turn true. It will set to false when it succeeds or fails.
When your request succeeds, store.getState().pender.success[ACTION_NAME] will turn true.
When your request fails, store.getState().pender.failure[ACTION_NAME] will turn true.

If you are currently using redux-promise or redux-promise-middleware in your project, there will be a collision. To avoid the collision without uninstalling existing library, pass { major: false } when you initialize the middleware:

1penderMiddleware({ major: false })

Actions

pender middleware will process the action when a Promise is given as the payload of the action:

1{
2    type: 'ACTION_TYPE',
3    payload: Promise.resolve()
4}

If you have set major to false when you initialize the middleware to avoid the collision with redux-promise or redux-promise-middleware, the middleware will only accept following action:

1{
2    type: 'ACTION_TYPE',
3    payload: {
4        pend: Promise.resolve()
5    }
6}

By default, middleware will accept both of the kinds of actions above.

Dispatching actions

Since it supports FSA actions, you can use createAction of redux-actions. The second parameter of createAction should be a function that returns a Promise.

1import axios from 'axios';
2import { createAction } from 'redux-actions';
3
4const loadPostApi = (postId) => axios.get(`https://jsonplaceholder.typicode.com/posts/${postId}`);
5const LOAD_POST = 'LOAD_POST';
6const loadPost = createAction(LOAD_POST, loadPostApi);
7store.dispatch(loadPost(1));

If you are using this middleware as {major: false}, you have to use createPenderAction

1import { createPenderAction } from 'redux-pender';
2const loadPost = createPenderAction(LOAD_POST, loadPostApi);

It pretty much works quite the same, but it puts the Promise at action.payload.pend.

Reducer - handling actions

When you are making your reducer, it works the best when you are using handleActions of redux-actions. Handling action is done by using pender.

For people who don't know what handleActions does, it handles action by creating an object, rather than a switch.

1
2import { handleActions } from 'redux-actions';
3import { pender } from 'redux-pender';
4
5const initialState = { 
6    post: {}
7}
8export default handleActions({
9    ...pender({
10        type: LOAD_POST,
11        onSuccess: (state, action) => {
12            return {
13                post: action.payload.data
14            };
15        }
16    }),
17    // ... other action handlers...
18}, initialState);

Do you want to do something when the action starts or fails? It is simple.

1...pender({
2    type: LOAD_POST,
3    onPending: (state, action) => {
4        return state; // do something
5    },
6    onSuccess: (state, action) => {
7        return {
8            post: action.payload.data
9        }
10    },
11    onFailure: (state, action) => {
12        return state; // do something
13    }
14}, initialState)

When you omit one of those function, (state, action) => state will be the default value. Additionally, it is not recommended to manage the status of request in your own reducer, because the penderReducer will do this for you. You just need to care about the result of your task in your reducer.

applyPenders - helper function that allows you to apply penders super easily.

1
2import { handleActions } from 'redux-actions';
3import { pender, applyPenders } from 'redux-pender';
4
5const initialState = { 
6    post: {}
7}
8
9const reducer = handleActions({
10    // ... some other action handlers...
11}, initialState);
12
13export default applyPenders(reducer, [
14    {
15        type: LOAD_POST,
16        onPending: (state, action) => {
17            return state; // do something
18        },
19        onSuccess: (state, action) => {
20            return {
21                post: action.payload.data
22            }
23        },
24        onFailure: (state, action) => {
25            return state; // do something
26        }
27    }
28])

Cancellation

Cancelling the promise based action is very simple in redux-pender. You just have to call .cancel() from the returned value of your promise based action creator.

1const p = loadPost(1);
2p.cancel();

When cancel is executed, redux-pender middleware will dispatch ACTION_TYPE_CANCEL. You can handle that action manually or configure onCancel in the action pender.

1...pender({
2    type: LOAD_POST,
3    onCancel: (state, action) => {
4        return state; // do something
5    }
6}, initialState)

Using in your React Component

1import React, { Component } from 'react';
2import * as actions from './actions';
3import { bindActionCreators } from 'redux';
4import { connect } from 'react-redux';
5
6class Example extends Component {
7
8    componentDidMount() {
9        this.fetchData();
10    }
11
12    async fetchData() {
13        const { Actions } = this.props;
14        try {
15            await Actions.loadPost(1);
16            console.log('data is fetched!');
17        } catch(e) {
18            console.log(e);
19        }
20    }
21
22    render() {
23        const { loading, post } = this.props;
24
25        return (
26            <div>
27                { loading && 'Loading...' }
28                <div>
29                    <h1>{post.title}</h1>
30                    <p>{post.body}</p>
31                </div>
32            </div>
33        );
34    }
35}
36
37export default connect(
38    state => ({
39        post: state.blog.post,
40        loading: state.pender.pending['LOAD_POST']
41    }),
42    dispatch => ({
43        Actions: bindActionCreators(actions, dispatch)
44    })
45)(Example)

Examples

An example project of using this library is provided in examples directory. If you want to see some more complex example, check out do-chat. It is a ChatApp project that uses firebase as backend.

Contributing

Contributions, questions and pull requests are all welcomed.

License

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.

Reason

145 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-42xw-2xvc-qx8m
Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99
Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-wxhq-pm8v-cw75
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-p28h-cc7q-c4fg
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-mpcf-4gmh-23w8
Warn: Project is vulnerable to: GHSA-9qj9-36jm-prpv
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr
Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-pp57-mqmh-44h7
Warn: Project is vulnerable to: GHSA-7px7-7xjx-hxm8
Warn: Project is vulnerable to: GHSA-x5pg-88wf-qq4p
Warn: Project is vulnerable to: GHSA-p9wx-2529-fp83
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-wrvr-8mpx-r7pp
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
Warn: Project is vulnerable to: GHSA-ff6r-5jwm-8292
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-6394-6h9h-cfjg
Warn: Project is vulnerable to: GHSA-28xh-wpgr-7fm8
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-hxcm-v35h-mg2x
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-5q6m-3h65-w53x
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-662x-fhqg-9p8v
Warn: Project is vulnerable to: GHSA-394c-5j6w-4xmx
Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
Warn: Project is vulnerable to: GHSA-pv4c-p2j5-38j4
Warn: Project is vulnerable to: GHSA-46c4-8wrp-j99v
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-cf66-xwfp-gvc4
Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-h726-x36v-rx45
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p

Score

1.7

/10

Last Scanned on 2025-06-09

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