Giter VIP home page Giter VIP logo

react-native-fetch-mock's Introduction

react-native-fetch-mock

Build Status Known Vulnerabilities npm version npm downloads Rate on Openbase

fetch mock for react-native

React Version

Why FetchMock ?

No fetch mock could be used easily for react-native.
So, I create one by myself.

Requirements

Nodejs >= 12.x

Roadmap

  • Combined with Mock.js
  • Support exclude for some other path
  • Proxy for other api server
  • Delay for global and specific path
  • Support flexible fallback to network(#6)
  • Support inline valiation(such as: '/api/users/{userid:[a-z|A-Z]}')

Usage

__ mocks__/index.js

export default {
  '/api/path': ({ method, url, params, urlparams, headers }) => {
    const all = Mock.mock({
      'list|2': [{
        'id|+1': 1,
        'name': '@first @last',
        'age|18-54': 1,
      }]
    }).list;
    return all;   // default status is 200
  },
  '/api/path/{id}': ({ method, url, params, urlparams, headers }) => {
    const all = Mock.mock({
      'list|2': [{
        'id|+1': 1,
        'name': '@first @last',
        'age|18-54': 1,
        'urlid': urlparams.id,
      }]
    }).list;
    return all;
  },
  'POST /api/path': ({ method, url, params, urlparams, headers }) => {
    return {
      status: 201,
    };
  },
  'PUT /api/path/${id}': ({ method, url, params, urlparams, headers }) => {
    return {
      status: 204,
      id: urlparams.id,
    };
  },
}

index.js

import FetchMock from 'react-native-fetch-mock';

if (__dev__) {
  global.fetch = new FetchMock(require('path/to/mocks/directory'), {
    delay: 200, // 200ms
    fetch: global.fetch,
    exclude: [
      'http://www.google.com',
      '/foo(.*)',
    ],
    fallbackToNetwork: true,  // ['true', 'false', 'always'], true: Unhandled calls fall through to the network;false: Unhandled calls throw an error; 'always': All calls fall through to the network, effectively disabling react-native-fetch-mock
    proxy: [{
      path: '/path/for/proxy(.*)',
      target: 'http://other.proxy.server',
      process: (proxied, matches) => {
        return `${proxied.target}${matches[1]}`,
      },
    }],
  }).fetch;
}

// if __dev__ is true, it will back the data you defined in mock directory
fetch('/api/path', options);
fetch('/api/path', {
  delay: 2000,      // /api/path will delayed after 2000ms. Most of suitation, this won't be used usually.
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'John',
  }),
});
fetch('/api/path/123', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'John2',
  }),
});

Example Runing

git clone [email protected]:WhatAKitty/react-native-fetch-mock.git
cd react-native-fetch-mock/example/Basic
npm install (attention: don't use yarn while install example dep)
react-native run-ios

LICENSE

MIT

react-native-fetch-mock's People

Contributors

dependabot[bot] avatar whatakitty avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

react-native-fetch-mock's Issues

ReferenceError: url is not defined

What am i doing wrong?

Thanks

//test.e2e.js

import FetchMock from 'react-native-fetch-mock';

if (__DEV__) {
   global.fetch = new FetchMock(require('../../__mocks__')).fetch;
}

function mockGetProfileAPI(token) {
   return fetch('https://api.xxx.com/profile', {
      method: 'GET',
      headers:{
         Authorization: v => v === Bearer ${token},
         'content-type': () => true,
         'accept-encoding': () => true,
          'user-agent': () => true,
         connection: () => true,
         accept: () => true,
         'content-length': () => true,
      },
      body: {
         data: {
            attributes: {
                 ...attributes,
           }
      }
   },
      url: 'https://api.xxx.com/profile'
   });
}

mockGetProfileAPI('mytoken');

//__mocks__/index.js

export default {
     'https://api.xxx.com/profile': ({ method, headers, body, url }) => {
          return {
               status: 201,
               data: {"attributes": {"name": "Guillermo"}}
          };
     }
}

Below is the stack trace:
ReferenceError: url is not defined

  at FetchMock.matchReqUrl (node_modules/react-native-fetch-mock/src/index.js:81:1678)

  at FetchMock.fetch (node_modules/react-native-fetch-mock/src/index.js:81:1841)

  at mockGetProfileAPI

[Enhancement] Exclude all non-matched option

Functionality to Exclude is awesome, but depending on project they might only want to mock a few calls and exclude all others. Perhaps an additional option to allow all non-matched urls to fallback to raw. Similar to fetch-mock's fallbackToNetwork option

Can't find variable: Symbol

When using the module I get that error. It was fixed when I added babel-polyfill but then I got warnnings:

Warning: Failed prop type: Invalid prop `children` of type `object` supplied to `Provider`, expected a single ReactElement.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.