JSPM

  • Created
  • Published
  • Downloads 1738332
  • Score
    100M100P100Q210996F
  • License MIT

Axios adapter that allows to easily mock requests

Package Exports

  • axios-mock-adapter

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (axios-mock-adapter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Installation

Using npm:

$ npm install axios-mock-adapter

Example

Mocking a GET request

var axios = require('axios');
var MockAdapter = require('axios-mock-adapter');

// This sets the mock adapter on the default instance
var mock = new MockAdapter(axios);
// which is the same as:
//   var mock = new MockAdapter();
//   axios.defaults.adapter = mock.adapter();

mock.onGet('/users').reply(200, {
  users: [
    { id: 1, name: 'John Smith' }
  ]
});

axios.get('/users')
  .then(function(response) {
    console.log(response.data);
  });

Passing a function to reply

mock.onGet('/users').reply(function(config) {
  // `config` is the axios config and contains things like the url

  // return an array in the form of [status, data, headers]
  return [200, {
    users: [
      { id: 1, name: 'John Smith' }
    ]
  }];
});

Using a regex

mock.onGet(/\/users\/\d+/).reply(function(config) {
  // the actual id can be grabbed from config.url

  return [200, {}];
});

API

mock.onGet(url)

mock.onHead(url)

mock.onPost(url)

mock.onPut(url)

mock.onPatch(url)

mock.onDelete(url)

url can either be a string or a regex.

Sending a reply

reply(status, data, headers)

Or you can pass a function that returns an array in the shape of: [status, data, headers]

reply(function)