Gathering detailed insights and metrics for @jedmao/redux-mock-store
Gathering detailed insights and metrics for @jedmao/redux-mock-store
A mock store for testing Redux async action creators and middleware.
Installations
npm install @jedmao/redux-mock-storeDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
12.16.1
NPM Version
6.14.2
Releases
10
Languages
1
TypeScript
TypeScript (100%)
Developer
jedmao
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
19 Stars
409 Commits
6 Forks
13 Branches
1 Contributors
Updated on Sep 18, 2024
Maintainers
1
Package Meta Information
Latest Version
3.0.5
Package Id
@jedmao/redux-mock-store@3.0.5
Unpacked Size
21.44 kB
Size
6.30 kB
File Count
10
NPM Version
6.14.2
Node Version
12.16.1
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
Dev Dependencies
29
@commitlint/cli@commitlint/config-conventional@jedmao/semantic-release-npm-github-config@testing-library/react@types/jest@types/node@types/react@types/react-dom@types/redux@types/redux-thunk@typescript-eslint/eslint-plugin@typescript-eslint/parsercommitizencz-conventional-changelogeslinteslint-config-prettiereslint-plugin-prettierhuskyjestjest-watch-typeaheadlint-stagedprettierreactreact-domredux-thunkrimrafsemantic-releasets-jesttypescript
@jedmao/redux-mock-store
A mock store for testing Redux async action creators and middleware. The mock store will create an array of dispatched actions which serve as an action log for tests.
This is a TypeScript fork of redux-mock-store.
Please note that this library is designed to test the action-related, not reducer-related logic (i.e., it does not update the Redux store). If you want a complex test combining actions and reducers together, take a look at other libraries (e.g., redux-actions-assertions). Refer to issue redux-mock-store#71 for more details.
Installation
1npm install @jedmao/redux-mock-store --save-dev
Or
1yarn add @jedmao/redux-mock-store --dev
Usage
You will benefit from configuring a single mockStore for all of your tests. A
common example would be to configure your store with a
redux-thunk middleware.
mockStore.js
1import { configureMockStore } from '@jedmao/redux-mock-store' 2import thunk from 'redux-thunk' 3 4const middlewares = [thunk] 5 6export default configureMockStore(middlewares)
Let's do the same thing in TypeScript and add an extra thunk argument.
mockStore.ts
1import { configureMockStore } from '@jedmao/redux-mock-store' 2import thunk, { ThunkDispatch } from 'redux-thunk' 3 4// internal dependencies 5import RootState from 'store/RootState' 6import RootActions from 'actions' 7 8const extraThunkArgument = { foo: 'bar' } 9const middlewares = [thunk.withExtraArgument(extraThunkArgument)] 10 11export default configureMockStore< 12 RootState, 13 RootActions, 14 ThunkDispatch<RootState, typeof extraThunkArgument, RootActions> 15>(middlewares)
Synchronous actions
The mock store saves all the dispatched actions inside the store instance. You
can get all the actions by calling store.getActions().
1import { mockStore } from 'utils/test' 2 3describe('todo actions', () => { 4 let store: ReturnType<typeof mockStore> 5 6 beforeEach(() => { 7 store = mockStore(/* initial state */) 8 }) 9 10 it('dispatches ADD_TODO', () => { 11 const action = { type: 'ADD_TODO' } 12 13 store.dispatch(action) 14 15 expect(store.getActions()[0]).toBe(action) 16 }) 17})
Asynchronous actions
1it('asynchronously dispatches SUCCESS', async () => { 2 const store = mockStore(/* initial state */) 3 const success = { type: 'SUCCESS' } 4 5 await store.dispatch(async dispatch => { 6 dispatch(success) 7 }) 8 9 expect(store.getActions()[0]).toBe(success) 10})
See the tests for more thorough examples.
API
configureMockStore
Configure the mock store by applying middlewares.
1configureMockStore< 2 S = any, 3 A extends Redux.Action = Redux.AnyAction, 4 DispatchExts extends {} | void = void 5>( 6 middlewares: Redux.Middleware[] = [], 7): MockStoreCreator<S, A, DispatchExts>
Calling configureMockStore will return a
MockStoreCreator, which returns an instance of the
configured mock store. This MockStoreCreator is a
function named mockStore.
mockStore
Call this function to reset your store after every test.
1function mockStore( 2 getState: S | MockGetState<S> = {} as S, 3): DispatchExts extends void 4 ? MockStore<S, A> 5 : MockStoreEnhanced<S, A, DispatchExts>
Mock Store API
dispatch
Dispatches an action T through the mock store. The action will be stored in an
array inside the instance and executed.
1dispatch<T extends A>(action: T): T
If DispatchExts are provided, dispatch will support an
additional signature.
1dispatch<R>( 2 asyncAction: ThunkAction<R, S, E, A>, 3): R
getState
Returns the state S of the mock store.
1getState(): S
getActions
Returns the actions A[] of the mock store.
1getActions(): A[]
clearActions
Clears the stored actions.
1clearActions(): void
subscribe
Subscribe a listener to the store.
1subscribe( 2 listener: (action: A) => void, 3): Redux.Unsubscribe
replaceReducer
Because a mock store does not have or support reducers, this function will always throw an error.
1replaceReducer(nextReducer: Reducer<S, A>): never
Mock stores do not support reducers. Try supplying a function to
getStoreinstead.
TypeScript
The @jedmao scoped
version of this library is written in TypeScript and published with generated
type information. No need to npm install additional
@types. Additionally, a number of types and
interfaces (below) have been exported for your convenience.
MockStoreCreator
If you provide DistpatchExts then this type will return a
MockStoreEnhanced, which supports async actions (e.g.,
thunks). Otherwise, it will just return a plain ol' MockStore
for sync actions.
1type MockStoreCreator< 2 S = {}, 3 A extends Action = AnyAction, 4 DispatchExts extends {} | void = void 5> = ( 6 state?: S | MockGetState<Redux.DeepPartial<S>>, 7) => DispatchExts extends void 8 ? MockStore<S, A> 9 : MockStoreEnhanced<S, A, DispatchExts>
MockGetState
This type is used in the MockStoreCreator via
state?: S | MockGetState<S>, which allows you to either supply a single state
object S or a function that would return S. Why a function? See
redux-mock-store#102.
1type MockGetState<S = {}> = (actions: AnyAction[]) => S
MockStoreEnhanced
Enables async actions (e.g., thunks).
1type MockStoreEnhanced< 2 S, 3 A extends Action = AnyAction, 4 DispatchExts = {} 5> = MockStore<Redux.DeepPartial<S>, A> & { 6 dispatch: DispatchExts 7}
MockStore
1interface MockStore<S = any, A extends Redux.Action = Redux.AnyAction> 2 extends Redux.Store<Redux.DeepPartial<S>, A> { 3 clearActions(): void 4 getActions(): A[] 5 subscribe(listener: (action: A) => void): Redux.Unsubscribe 6}
License
The MIT License
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/master.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/jednano/redux-mock-store/master.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/master.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/jednano/redux-mock-store/master.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/master.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/jednano/redux-mock-store/master.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/master.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/jednano/redux-mock-store/master.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/jednano/redux-mock-store/pr.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/jednano/redux-mock-store/pr.yml/master?enable=pin
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 3 out of 3 npmCommand dependencies pinned
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/master.yml:1
- Warn: no topLevel permission defined: .github/workflows/pr.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v3.0.5 not signed: https://api.github.com/repos/jednano/redux-mock-store/releases/25054319
- Warn: release artifact v3.0.4 not signed: https://api.github.com/repos/jednano/redux-mock-store/releases/25047902
- Warn: release artifact v3.0.3 not signed: https://api.github.com/repos/jednano/redux-mock-store/releases/25029110
- Warn: release artifact v3.0.2 not signed: https://api.github.com/repos/jednano/redux-mock-store/releases/24981202
- Warn: release artifact v3.0.1 not signed: https://api.github.com/repos/jednano/redux-mock-store/releases/24328721
- Warn: release artifact v3.0.5 does not have provenance: https://api.github.com/repos/jednano/redux-mock-store/releases/25054319
- Warn: release artifact v3.0.4 does not have provenance: https://api.github.com/repos/jednano/redux-mock-store/releases/25047902
- Warn: release artifact v3.0.3 does not have provenance: https://api.github.com/repos/jednano/redux-mock-store/releases/25029110
- Warn: release artifact v3.0.2 does not have provenance: https://api.github.com/repos/jednano/redux-mock-store/releases/24981202
- Warn: release artifact v3.0.1 does not have provenance: https://api.github.com/repos/jednano/redux-mock-store/releases/24328721
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Reason
52 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-2h3h-q99f-3fhc
- Warn: Project is vulnerable to: GHSA-gmw6-94gg-2rc2
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- 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-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- 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-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-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-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-hj9c-8jmm-8c52
- 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-x2pg-mjhr-2m5x
- 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-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-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
2.5
/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