fetch-mock
Advanced tools
fetch-mock - npm Package Compare versions
Comparing version 2.2.3 to 2.2.6
@@ -1,1 +0,1 @@ | ||
| {"name":"fetch-mock","version":"2.2.3","description":"Mock http requests made using fetch (or isomorphic-fetch)","main":"server.js","scripts":{"test":"make test"},"repository":{"type":"git","url":"https://github.com/wheresrhys/fetch-mock.git"},"keywords":["fetch","http","mock","testing","spy"],"author":"Rhys Evans","license":"ISC","bugs":{"url":"https://github.com/wheresrhys/fetch-mock/issues"},"homepage":"https://github.com/wheresrhys/fetch-mock","dependencies":{"node-fetch":"^1.2.0","debug":"^2.2.0"},"devDependencies":{"babelify":"^6.3.0","browserify":"^10.0.0","chai":"^2.3.0","coveralls":"^2.11.2","debowerify":"^1.2.1","es6-promise":"^2.1.1","karma":"^0.12.31","karma-browserify":"^4.1.2","karma-chai":"^0.1.0","karma-chrome-launcher":"^0.1.8","karma-mocha":"^0.1.10","mocha":"^2.2.4","mocha-lcov-reporter":"0.0.2","npm-prepublish":"^1.2.0","sinon":"^1.17.0"}} | ||
| {"name":"fetch-mock","version":"2.2.6","description":"Mock http requests made using fetch (or isomorphic-fetch)","main":"server.js","scripts":{"test":"make test"},"repository":{"type":"git","url":"https://github.com/wheresrhys/fetch-mock.git"},"keywords":["fetch","http","mock","testing","spy"],"author":"Rhys Evans","license":"ISC","bugs":{"url":"https://github.com/wheresrhys/fetch-mock/issues"},"homepage":"https://github.com/wheresrhys/fetch-mock","dependencies":{"node-fetch":"^1.2.0","debug":"^2.2.0"},"devDependencies":{"babelify":"^6.3.0","browserify":"^10.0.0","chai":"^2.3.0","coveralls":"^2.11.2","debowerify":"^1.2.1","es6-promise":"^2.1.1","karma":"^0.12.31","karma-browserify":"^4.1.2","karma-chai":"^0.1.0","karma-chrome-launcher":"^0.1.8","karma-mocha":"^0.1.10","mocha":"^2.2.4","mocha-lcov-reporter":"0.0.2","npm-prepublish":"^1.2.0","sinon":"^1.17.0"}} |
115
README.md
| # fetch-mock [](https://travis-ci.org/wheresrhys/fetch-mock) [](https://coveralls.io/r/wheresrhys/fetch-mock) | ||
| A versatile mocking library for http requests made using fetch (or isomorphic-fetch). The simplest case is: | ||
| Mock http requests made using fetch (or [isomorphic-fetch](https://www.npmjs.com/package/isomorphic-fetch)). As well as shorthand methods for the simplest use cases, it offers a flexible API for customising mocking behaviour, and can also be persisted (with resettable state) over a series of tests. | ||
| ``` | ||
| const fetchMock = require('fetch-mock'); | ||
| it('should pretend to be Rambo', done => { | ||
| fetchMock.mock('http://rambo.was.ere', 301); | ||
| fetch('http://rambo.was.ere') | ||
| .then(res => { | ||
| expect(fetchMock.calls().length).to.equal(1); | ||
| expect(res.status).to.equal(301); | ||
| fetchMock.restore(); | ||
| done(); | ||
| }); | ||
| }) | ||
| ``` | ||
| ## API | ||
| Requests can be mocked based on a wide range of criteria (method, headers, url), and return any response needed. Routes can also be persisted over a series of tests and identified by name, with some useful shorthand syntaxes to make common use cases easier to write. See the docs below. | ||
| - *fetch-mock doesn't declare `fetch` or `Promise` as dependencies; it's assumed you or your environment are already taking care of these globals* | ||
| - *To output useful messages for debugging `export DEBUG=fetch-mock`* | ||
| *notes* | ||
| - When using isomorphic-fetch or node-fetch ideally `fetch` should be added as a global. If not possible to do so you can still use fetch-mock in combination with [mockery](https://github.com/mfncooper/mockery) in nodejs (see `useNonGlobalFetch(func)` below) | ||
| - fetch-mock doesn't declare `fetch` or `Promise` as dependencies; as you're testing `fetch` it's assumed you're already taking care of these globals | ||
| - fetch-mock uses [npm debug](https://www.npmjs.com/package/debug). To output useful messages for debugging set the environment variable `DEBUG=fetch-mock` | ||
| - To use fetch-mock on the server simply `npm install fetch-mock` and `require('fetch-mock)`. In the browser either | ||
| - use browserify + debowerify and both `npm install fetch-mock` and `bower install fetch-mock`, then use `require('fetch-mock)` | ||
| - use browserify and `npm install fetch-mock` and `require('fetch-mock/client)` | ||
| **`require('fetch-mock')`** exports a singleton with the following methods | ||
| ## API | ||
| `require('fetch-mock')` exports a singleton with the following methods | ||
| ### `mock(config)` | ||
| ### `mock()` | ||
| Replaces `fetch()` with a stub which records it's calls, grouped by route, and optionally returns a stub response or passes the call through to `fetch()`. | ||
| `config` is an optional (when persistent routes are already defined using `registerRoute`) object with properties as below: | ||
| > ##### *Shorthand notation for simplest use cases* | ||
| The following are also accepted by mock() and translated into `config` objects with the `routes` property defined using the values passed in to mock as follows: | ||
| * `mock(matcher, method, response)` - configuration for a single unnamed route to be mocked for a given method. To access details of its calls `fetchMock.calls()` should be called without passing a parameter | ||
| * `mock(matcher, response)` - configuration for a single unnamed route to be mocked. To access details of its calls `fetchMock.calls()` should be called without passing a parameter | ||
| * `mock(route)` - configuration object for a single route | ||
| * `mock(routes)` - array of route configuration objects | ||
| * `routes`: Either a single object or an array of similar objects each defining how the mock handles a given request. If multiple routes are specified the first matching route will be used to define the response. Each route object must have the following properties. | ||
| * `name`: A unique string naming the route | ||
| * `method`: If specified will only match requests using the given http method | ||
| * `matcher`: The rule for matching calls to `fetch()`. Accepts any of the following | ||
| * `mock(matcher, response)` - configuration for a single unnamed route to be mocked (shorthand for `mock(route)` - see below) | ||
| * `mock(matcher, method, response)` - configuration for a single unnamed route to be mocked for a given method (shorthand for `mock(route)` - see below) | ||
| * `mock(route)` - configuration for a single route with the following properties | ||
| * `name` [required]: A unique string naming the route | ||
| * `method` [optional]: If specified will only match requests using the given http method | ||
| * `matcher` [required]: The rule for matching calls to `fetch()`. Accepts any of the following | ||
| * `string`: Either an exact url to match e.g. 'http://www.site.com/page.html' or, if the string begins with a `^`, the string following the `^` must begin the url e.g. '^http://www.site.com' would match 'http://www.site.com' or 'http://www.site.com/page.html' | ||
| * `RegExp`: A regular expression to test the url against | ||
| * `Function(url, opts)`: A function that is passed the url and opts `fetch()` is called with and that returns a Boolean. | ||
| * `response`: Configures the response object returned by the mock. Can take any of the following values | ||
| * `response` [required]: Configures the response object returned by the mock. Can take any of the following values | ||
| * `number`: creates a response with the number as the response status | ||
@@ -66,20 +34,23 @@ * `string`: creates a 200 response with the string as the response body | ||
| * `Function(url, opts)`: A function that is passed the url and opts `fetch()` is called with and that returns any of the responses listed above | ||
| * `responses`: When `registerRoute()` has already been used to register some routes then `responses` can be used to override the default response. Its value should be an object mapping route names to responses, which should be similar to those listed immediately above e.g. | ||
| * `mock(routes)` - array of route configuration objects (see above) | ||
| * `mock(config)` - object containing more complex config for fine grained controlled over mocking behaviour with the following properties | ||
| - `routes`: Either a single route config object or an array of them (see above) | ||
| - `responses`: When `registerRoute()` has already been used to register some routes then `responses` can be used to override the default response. Its value should be an object mapping route names to responses, which should be similar to those provided in the `response` property of stanadard route configurations e.g. | ||
| ```javascript | ||
| responses: { | ||
| session: function (url, opts) { | ||
| if (opts.headers.authorized) { | ||
| return {user: 'dummy-authorized-user'}; | ||
| } else { | ||
| return {user: 'dummy-unauthorized-user'}; | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| ```javascript | ||
| responses: { | ||
| session: function (url, opts) { | ||
| if (opts.headers.authorized) { | ||
| return {user: 'dummy-authorized-user'}; | ||
| } else { | ||
| return {user: 'dummy-unauthorized-user'}; | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| * `greed`: Determines how the mock handles unmatched requests | ||
| * 'none': all unmatched calls get passed through to `fetch()` | ||
| * 'bad': all unmatched calls result in a rejected promise | ||
| * 'good': all unmatched calls result in a resolved promise with a 200 status | ||
| - `greed`: Determines how the mock handles unmatched requests | ||
| - 'none': all unmatched calls get passed through to `fetch()` | ||
| - 'bad': all unmatched calls result in a rejected promise | ||
| - 'good': all unmatched calls result in a resolved promise with a 200 status | ||
@@ -96,2 +67,4 @@ | ||
| When shorthands are used by `mock()` to define unnamed routes `routeName` is not required (but `_mock` can be passed in to distinguish from calls to previously registered routes) | ||
| ### `called(routeName)` | ||
@@ -115,4 +88,4 @@ Returns a Boolean denoting whether any calls matched the given route. '__unmatched' can be passed in to return results for calls not matching any route. If no routeName is passed it returns `true` if any fetch calls were made | ||
| ### `useNonGlobalFetch(func)` | ||
| To use fetch-mock with with [mockery](https://github.com/mfncooper/mockery) you will need to use this function to prevent fetch-mock trying to mock the function globally. | ||
| * `func` Optional reference to `fetch` (or any other function you may want to substitute for `fetch` in your tests). This will be converted to a `sinon.stub` and can be accessed via `fetchMock.fetch` | ||
| When using isomorphic-fetch or node-fetch ideally `fetch` should be added as a global. If not possible to do so you can still use fetch-mock in combination with [mockery](https://github.com/mfncooper/mockery) in nodejs. To use fetch-mock with with [mockery](https://github.com/mfncooper/mockery) you will need to use this function to prevent fetch-mock trying to mock the function globally. | ||
| * `func` Optional reference to `fetch` (or any other function you may want to substitute for `fetch` in your tests). | ||
@@ -135,7 +108,5 @@ #### Mockery example | ||
| }); | ||
| ``` | ||
| ## More complex examples | ||
| ## Examples | ||
| ```javascript | ||
@@ -145,2 +116,14 @@ | ||
| // Simplest use case | ||
| it('should pretend to be Rambo', done => { | ||
| fetchMock.mock('http://rambo.was.ere', 301); | ||
| fetch('http://rambo.was.ere') | ||
| .then(res => { | ||
| expect(fetchMock.calls().length).to.equal(1); | ||
| expect(res.status).to.equal(301); | ||
| fetchMock.restore(); | ||
| done(); | ||
| }); | ||
| }) | ||
| // Optionally set up some routes you will always want to mock | ||
@@ -147,0 +130,0 @@ // Accepts an array of config objects or three parameters, |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-1.81%
47041
- Number of lines in readme file
- decreased by-6.44%
247
No dependency changes