Gathering detailed insights and metrics for axios-hooks-mock
Gathering detailed insights and metrics for axios-hooks-mock
Installations
npm install axios-hooks-mockScore
56.1
Supply Chain
97.2
Quality
74.7
Maintenance
100
Vulnerability
99.6
License
Releases
Unable to fetch releases
Developer
dkershner6
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
Typescript Support
Yes
Node Version
12.19.0
NPM Version
6.14.8
Statistics
21 Commits
3 Watching
5 Branches
1 Contributors
Updated on 28 Jan 2023
Bundle Size
2.83 kB
Minified
1.19 kB
Minified + Gzipped
Languages
TypeScript (98.11%)
JavaScript (1.89%)
Total Downloads
Cumulative downloads
Total Downloads
149,521
Last day
-17.8%
60
Compared to previous day
Last week
-9%
363
Compared to previous week
Last month
-4.9%
1,851
Compared to previous month
Last year
-36.8%
25,010
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
3
Dev Dependencies
29
@testing-library/jest-dom@testing-library/react@testing-library/user-event@types/jest@types/node@types/react@types/react-dom@types/react-router-dom@typescript-eslint/eslint-plugin@typescript-eslint/parseraxiosaxios-hookscross-enveslinteslint-config-prettiereslint-plugin-jesteslint-plugin-prettiereslint-plugin-reacteslint-plugin-react-hookseslint-plugin-testing-libraryjestmicrobundleprettierreactreact-domrimrafts-jestts-nodetypescript
Versions
axios-hooks-mock
A library that simplifies mocking for axios-hooks, especially when multiple hooks are used together.
This library has full test coverage to ensure each scenario works and is written in TypeScript.
Installation
npm i axios axios-hooks
npm i -D axios-hooks-mock
Usage
Full Examples are available in the tests folder
There are a few ways to use this library to achieve your complex mocking goals. Examples will use jest, but this could also be used with other testing libraries. Any usage of mocked is using ts-jest/utils.
The library matches on a combination of method, url, and params. You must create one implementation per each combination you want to satisfy.
Each method of adding implementations accepts either a string (the url) or an AxiosRequestConfig object (this is the object you are used to, including url, method, params, data, etc.). The convenience methods only accept the url string (for hopefully obvious reasons).
You can use any combination of the below.
Always
1jest.mock('axios-hooks');
Having the library do this would make it far less flexible.
Convenience Methods
1import AxiosHooksMock from 'axios-hooks-mock'; 2 3const refetch = jest.fn(); 4mocked(useAxios).mockImplementation( 5 new AxiosHooksMock() 6 .get('https://testapi.com', [ 7 { data: { testData: 'theData' }, loading: false }, 8 refetch 9 ]) 10 // Chain as many as you want 11 .implement() 12);
addImplementation()
1import AxiosHooksMock from 'axios-hooks-mock'; 2 3const refetch = jest.fn(); 4mocked(useAxios).mockImplementation( 5 new AxiosHooksMock() 6 .addImplementation({ url: 'https://testapi.com', method: 'GET' }, [ 7 { data: { testData: 'theData' }, loading: false }, 8 refetch 9 ]) 10 // Chain as many as you want 11 .implement() 12);
AxiosHooksMockItem Array + Constructor
This allows for a configuration array to be handed into the constructor like so:
1import AxiosHooksMock from 'axios-hooks-mock'; 2 3const refetch = jest.fn(); 4 5const implementations: AxiosHooksMockItem[] = [ 6 { 7 config: { url: 'https://testapi.com', method: 'GET' }, 8 implementation: [ 9 { data: { testData: 'theData' }, loading: false }, 10 refetch 11 ] 12 } 13 // As many as you want 14]; 15 16mocked(useAxios).mockImplementation( 17 new AxiosHooksMock(implementations).implement() 18);
Default Implementation
This allows you to return a tuple when nothing matches, as a backup. Two ways to use it, similar to other methods.
default()
1import AxiosHooksMock from 'axios-hooks-mock'; 2 3const refetch = jest.fn(); 4mocked(useAxios).mockImplementation( 5 new AxiosHooksMock() 6 .get('https://testapi.com', [ 7 { data: { testData: 'theData' }, loading: false }, 8 refetch 9 ]) 10 .default([{ data: undefined, loading: false }]) 11 .implement() 12);
Second param of constructor
1const default = [{ data: undefined, loading: false }]; 2mocked(useAxios).mockImplementation( 3 new AxiosHooksMock(implementations, default).implement() 4);
Alternate constructor
If you like: AxiosHooksMock.construct(implementations).implement();
API
AxiosHooksTuple
This is what is returned from useAxios().
1type AxiosHooksTuple = [ 2 ResponseValues<unknown>, 3 ( 4 config?: AxiosRequestConfig | string, 5 options?: RefetchOptions 6 ) => AxiosPromise<unknown> 7];
Constructor
| Param | Required | Type |
|---|---|---|
| implementations | false | `{ config: AxiosRequestConfig |
addImplementation()
| Param | Required | Type |
|---|---|---|
| config | true | `AxiosRequestConfig |
| implementation | true | AxiosHooksTuple |
get(), post(), patch(), delete()
| Param | Required | Type |
|---|---|---|
| url | true | string; |
| implementation | true | AxiosHooksTuple |
implement()
No Params
Q & A
Can this library give me a loading status, then change to a data response, like in real life?
No. This would vastly increase the complexity of your test, including async waiting, a Provider that would need to wrap your code and intercept useAxios requests, and more. It is much easier to test each state separately.
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
Found 7/8 approved changesets -- score normalized to 8
Reason
dependency not pinned by hash detected -- score normalized to 1
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/pr.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/pr.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/pr.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/pr.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/pr.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-publish.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/release-publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-publish.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/release-publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-publish.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/release-publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-publish.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/release-publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-publish.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/release-publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-publish.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/release-publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-publish.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/release-publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-publish.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/dkershner6/axios-hooks-mock/release-publish.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/release-publish.yml:51
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 7 third-party GitHubAction dependencies pinned
- Info: 1 out of 2 npmCommand dependencies pinned
Reason
project is archived
Details
- Warn: Repository is archived.
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/pr.yml:1
- Warn: no topLevel permission defined: .github/workflows/release-publish.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
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 20 are checked with a SAST tool
Reason
47 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- 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-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
- 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-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-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
- Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- 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-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
- 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-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- 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
Score
3.7
/10
Last Scanned on 2024-11-25
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