npmpackage.info

Gathering detailed insights and metrics for use-reducer-effect

Other packages similar to use-reducer-effect

use-effect-reducer

0.7.0

A [React hook](https://reactjs.org/docs/hooks-intro.html) for managing side-effects in your reducers.

use-backlash

0.0.32

useReducer with effects

use-railway

0.0.12

useReducer with effects

react-use-backlash

0.0.32

useReducer with effects

Gathering detailed insights and metrics for use-reducer-effect

use-reducer-effect - 1.1.2 | npmpackage.info

use-reducer-effect

A tiny library that enables side effects with the useReducer hook

1.1.2

MIT

TypeScript

13.58 kB

1.7

Installations

npm install use-reducer-effect

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

8.17.0

NPM Version

6.12.0 Pull Requests

Open

21

Total

25

Closed

4

Issues

Open

1

Total

1

Closed

0

Releases

v1.1.2

Updated on Feb 02, 2020

v1.1.1

Updated on Feb 02, 2020

v1.1.0

Updated on Feb 02, 2020

v1.0.0

Updated on Oct 13, 2019

View All 4 releases

Languages

TypeScript

JavaScript

TypeScript (88.83%)

JavaScript (11.17%)

Developer

Jibbedi

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

13 Stars

17 Commits

1 Forks

2 Watchers

22 Branches

1 Contributors

Updated on Dec 18, 2024

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.1.2

Package Id

use-reducer-effect@1.1.2

Unpacked Size

13.58 kB

Size

4.92 kB

File Count

NPM Version

6.12.0

Node Version

8.17.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

🧪 useReducer Effects ↩️

A tiny library that enables side effects with the useReducer hook

The Problem
The Solution
Getting started
Defining the effect function
Data Flow
API
- useReducerWithSideEffects(reducer, effect, initialValue?, init?)
- Effect Function
Advanced
- createSideEffectReducer
Examples
- 🔗 API Call
- 🔗 Logging
Acknowledgments
Contributors

The Problem

You are using the useReducer hook to manage your state, but you need a way to perform side effects (like fetching data from an API or logging) without mixing those concern together.

The Solution

use-reducer-effect let's you define a second function next to the reducer function, where you can manage your side effects.

This way you can run your side effect logic on certain actions, while also allowing side effects to update the store by dispatching new actions.

Getting started

Install the library with

1npm install --save use-reducer-effect

and import the hook into your code

1import { useReducerWithSideEffects } from "use-reducer-effect";

If you already use a reducer to manage your state you will feel right at home with using them to manage side effects to.

useReducerWithSideEffects uses the same API as useReducer does, but gives you the ability to define a function which is called after your reducer function has run to run additional logic like fetching data from an API.

Defining the effect function

The effect function takes the same argument as the reducer function. state and action.

Instead of modifying the state, it is responsible for handling side effects like making http calls.

Let's assume we want to fetch from an API whenever an action called LOAD is dispatched. When the data is there, we want to feed it back into our reducer.

Note: The effect function will be called after the reducer has updated the state.

1// define the reducer as usual
2function reducer(state: State, action) {
3  switch (action.type) {
4    case ACTION_LOAD: // this action is dispatched by clicking on the button
5      return { ...state, loading: true };
6    case ACTION_LOAD_SUCCESSFUL: // this action is dispatched by the side effect. We'll learn how to do this in a minute.
7      return { ...state, loading: false, data: action.payload };
8  }
9
10  return state;
11}
12
13// define the effect function which is executed after the reducer has run
14async function effect(state, action) {
15  switch (action.type) {
16    case ACTION_LOAD:
17      const response = await fetch(
18        `https://api.github.com/users/${action.payload}/repos`
19      );
20      const data = await response.json();
21      return {
22        type: ACTION_LOAD_SUCCESSFUL,
23        payload: data
24      };
25  }
26}
27
28// using the hook
29const MyComponent = () => {
30  const [state, dispatch] = useReducerWithSideEffects(reducer, effect);
31};

Data Flow

Data flow visualization

The action LOAD is dispatched with a payload (in this case the GitHub username)
The reducer function is run and updated state is returned to the component
The effect function is called, which has access to the updated state and the dispatched action (LOAD)
The effect function triggers an http request
It dispatches the action ACTION_LOAD_SUCCESSFUL with the API response data as payload
The reducer function is called again (ACTION_LOAD_SUCCESSFUL) and updates the state
The effect function is called again with the new state (API response) and the action ACTION_LOAD_SUCCESSFUL. We didn't register a side effect for this action so it doesn't do anything.

API

useReducerWithSideEffects(reducer, effect, initialValue?, init?)

The only difference between this function and useReducer is the effect function you need to provide as the second argument.

Effect Function

function(state, action) => Promise<action|undefined>

The effect function is called with the updated state and the action that caused the state update. It needs to return a Promise (async/await works great here) with either a action if you want to update the state again (i.e. after fetching from an API) or undefined if you do not want to update the state (i.e. if you want to use a side effect for logging purposes only)

Advanced

createSideEffectReducer

It is possible to use the higher order function createSideEffectReducer which takes the effect function as it's only argument to create a hook which provides you with the exact API signature that useReducer uses.

This way you can provide a nice abstraction for shared functionality like logging.

1const useLoggingReducer = createSideEffectReducer(async (state, action) => {
2  console.log("Action", action);
3  console.log("Current State", state);
4});
5
6const MyComponent = () => {
7  const [state, dispatch] = useLoggingReducer(reducer, {
8    count: 0
9  });
10};

Examples

🔗 API Call

Use the effect function to handle data fetching from an API

🔗 Logging

Use createSideEffectReducer to create a useReducer like hook that logs all actions and state changes.

Acknowledgments

This library is greatly inspired by the idea of ngrx effects, which is an awesome library if your working with Angular.

Contributors

_{Johannes Kling}
💻 📖 🤔 💡 ⚠️

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

Code-Review

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

0

SAST

Determines if the project uses static code analysis.

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

88 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-2mj8-pj3j-h362
Warn: Project is vulnerable to: GHSA-gqf6-75v8-vr26
Warn: Project is vulnerable to: GHSA-v45m-2wcp-gg98
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-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
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-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
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-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
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-w7rc-rwvf-8q5r
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-m6cx-g6qm-p2cx
Warn: Project is vulnerable to: GHSA-x8qc-rrcw-4r46
Warn: Project is vulnerable to: GHSA-4328-8hgf-7wjr
Warn: Project is vulnerable to: GHSA-93f3-23rq-pjfp
Warn: Project is vulnerable to: GHSA-jmqm-f2gx-4fjv
Warn: Project is vulnerable to: GHSA-pw54-mh39-w3hc
Warn: Project is vulnerable to: GHSA-xgh6-85xh-479p
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-r2j6-p67h-q639
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2025-07-07

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

Other packages similar to use-reducer-effect

Other packages similar to use-reducer-effect

use-reducer-effect

Installations

Developer Guide

Yes

CommonJS

8.17.0

6.12.0

Pull Requests

21

25

4

Issues

1

1

0

Releases

Languages

Developer

Jibbedi

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Dev Dependencies

🧪 useReducer Effects ↩️

A tiny library that enables side effects with the useReducer hook

Table of Contents

The Problem

The Solution

Getting started

Defining the effect function

Data Flow

API

useReducerWithSideEffects(reducer, effect, initialValue?, init?)

Effect Function

Advanced

createSideEffectReducer

Examples

🔗 API Call

🔗 Logging

Acknowledgments

Contributors

10

10

0

0

0

0

0

0

0

0

1.7

/10