npmpackage.info

Gathering detailed insights and metrics for xhr-mocklet

Other packages similar to xhr-mocklet

xhr

2.6.0

small xhr abstraction

@videojs/xhr

2.7.0

small xhr abstraction

xhr-request-promise

0.1.3

Thin wrapper on top of [this](https://www.npmjs.com/package/xhr-request) to use Promise instead of callbacks.

xmlhttprequest-ssl

3.0.0

XMLHttpRequest for Node

Gathering detailed insights and metrics for xhr-mocklet

xhr-mocklet

Mock XMLHttpRequests in both the browser and node

1.2.3

TypeScript

7,398,838 1.7

Installations

npm install xhr-mocklet

Pull Requests

Open

0

Total

13

Closed

0

Merged

13

Issues

Open

7

Total

9

Closed

2

Releases

1.2.3

Published on 20 Nov 2018

1.2.2

Published on 20 Nov 2018

1.2.1

Published on 31 Aug 2017

1.2.0

Published on 31 Aug 2017

1.1.0

Published on 14 Mar 2017

1.0.0

Published on 14 Mar 2017

View all 6 releases

Developer

marvinhagemeister

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

9.11.1

NPM Version

6.4.1 Statistics

5 Stars

70 Commits

1 Forks

4 Watching

5 Branches

9 Contributors

Updated on 04 Jan 2020

Languages

TypeScript (97.17%)

Shell (2.83%)

Total Downloads

Cumulative downloads

Total Downloads

7,398,838

Last day

66.7%

15,379

Compared to previous day

Last week

25.7%

71,821

Compared to previous week

Last month

102.6%

277,358

Compared to previous month

Last year

40.1%

2,002,414

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@types/event-emitter event-emitter global

Dev Dependencies

@types/chai @types/mocha @types/node @types/sinon chai husky mocha nyc rimraf sinon ts-node tslint typescript

Versions

XMLHttpRequest mocking

Utility for mocking XMLHttpRequests both in the browser and nodejs. It's primary use case is for unit tests, allowing you to respond with mock responses, trigger timeouts, etc.

This library comes with complete TypeScript declaration files.

Installation

1# NPM
2npm install --save --dev xhr-mocklet
3
4# Or via yarn:
5yarn add --dev xhr-mocklet

Usage

1const mock = require('xhr-mocklet');
2
3// Replace the real XHR object with the mock XHR object
4mock.setup();
5
6// Mock a response for all POST requests to http://localhost/api/user
7mock.post('http://localhost/api/user', (req, res) => {
8  return res
9    .status(201)
10    .header('Content-Type', 'application/json')
11    .body({
12      lastName: 'John',
13      firstName: 'Smith'
14    });
15});
16
17// Restore the original XHR object when all your tests are done.
18mock.teardown();

Simulating an error

Simply return null from your response handler:

1mock.post('http://localhost/foo', (req, res) => null);

Simulate a timeout

1mock.post('http://localhost/foo', (req, res) => res.timeout(true));

Use mocked `XMLHttpRequest`

You can even use a mocked XMLHttpReqeuest instance to create Requests:

1// Create an instance of the (mock) XHR object and use as per normal
2const xhr = new XMLHttpRequest();
3
4xhr.onreadystatechange = () => {
5  if (xhr.readyState === xhr.DONE) {
6    // when you're finished put the real XHR object back
7    mock.teardown();
8  }
9}

API

Builder

Method	Description
`setup()`	Replace the global `XMLHttpRequest` object with the `MockXMLHttpRequest`.
`teardown()`	Restore the global `XMLHttpRequest` object to its original state.
`reset()`	Remove all request handlers.
`get(url: string \| regex, callback)`	Create `GET` mock response for a specific url.
`post(url: string \| regex, callback)`	Create `POST` mock response for a specific url.
`put(url: string \| regex, callback)`	Create `PUT` mock response for a specific url.
`patch(url: string \| regex, callback)`	Create `PATCH` mock response for a specific url.
`delete(url: string \| regex, callback)`	Create `DELETE` mock response for a specific url.
`mock(callback)`	Register mock response for every request.

MockXMLHttpRequest

The api is practically similar to the native XMLHttpRequest.

MockRequest

Method	Description
`method(): string`	Get the request method.
`url(): string`	Get the request URL.
`query(): object`	Get the parsed query part of the request URL.
`header(name: string): string`	Get a request header.
`headers(): object`	Get all request headers.
`body(): string`	Get the request body.

MockResponse

Method	Description
`status(): number`	Get the response status.
`status(code: number)`	Set the response status.
`header(name: string): string`	Get a response header.
`header(name: string, value: string)`	Set a response header.
`headers(): object`	Get response headers.
`headers(headers: obejct)`	Set response headers.
`body(): string`	Get response body.
`body(body: string)`	Set response body.
`timeout(): boolean \| number`	Get weather the response will trigger a timeout.
`timeout(ms: boolean \| number)`	Set a timeout, otherwise default to the value set on the XHR object.
`progress(loaded: number, total: number, lengthComputable: boolean)`	Trigger progress event. Pass in loaded size, total size and if event is lengthComputable.

Special Thanks

Special thanks goes to James Newell for his xhr-mock library. xhr-mocklet started out as a fork of his work.

No vulnerabilities found.

10

Binary-Artifacts

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

3

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

License

Determines if the project has defined a license.

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

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

38 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-832h-xg76-4gv6
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-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-qh2h-chj9-jffq
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-43f8-2h32-f4cj
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-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
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 2024-11-18

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 xhr-mocklet

Other packages similar to xhr-mocklet

xhr-mocklet

Installations

Pull Requests

0

13

0

13

Issues

7

9

2

Releases

Developer

marvinhagemeister

Developer Guide

CommonJS

No

9.11.1

6.4.1

Statistics

Languages

Total Downloads

7,398,838

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

XMLHttpRequest mocking

Installation

Usage

Simulating an error

Simulate a timeout

Use mocked XMLHttpRequest

API

Builder

MockXMLHttpRequest

MockRequest

MockResponse

Special Thanks

10

3

0

0

0

0

0

0

0

0

1.7

/10

Use mocked `XMLHttpRequest`