fake-browser-fetch
TypeScript icon, indicating that this package has built-in type declarations

0.0.2 • Public • Published

Fake Browser fetch · ci-badge

If you hate spinning up a web server everytime you are building a small pet project or demo project then this is for you 🎉

Features 💥

  • fake GET/POST/PUT/DELETE fetch requests
  • induce delay to any fetch request
  • fake a 404 or error response
  • generate response dynamically based on the request

How to use ❓

  1. Install it using npm
npm i --dev fake-browser-fetch
  1. Add it to your front-end project to fake a simple GET request
import fakeFetch from 'fake-browser-fetch';
 
...
 
if(process.env.NODE_ENV === 'development') {
  fakeFetch([{
    request: '/api/users/ameerthehacker',
    response: new Response(JSON.stringify({ name: "Ameer Jhan" })),
    // delay in milliseconds
    delay: 3000
  }]);
}
 
...
 
// will print { name: "Ameer Jhan" } after 3s
fetch('/api/users/ameerthehacker')
      .then(res => res.json())
      .then(user => console.log(user));

API

Faking a POST/PUT/DELETE request

fakeFetch([
  {
    request: new Request('/api/users/create', {
      method: 'POST',
      body: JSON.stringify({
        name: 'Ameer Jhan',
        username: 'ameerthehacker'
      })
    }),
    response: new Response(JSON.stringify({ done: true }))
  }
]);

Dynamic response based on request

fakeFetch([
  {
    request: new Request('/api/add', {
      method: 'POST',
      body: JSON.stringify({ name: 'Ameer' })
    }),
    response: async (request) => {
      const body = await request.json();
 
      return new Response(body.name.toLowerCase());
    }
  }
]);
 
fetch(`/api/add`, {
  body: JSON.stringify({ name: 'Ameer' })
})
  .then((res) => res.text())
  // this will print `ameer`
  .then((res) => console.log(res));

Faking a request to throw an error

const error = new Error('ETIMEOUT: the server timedout');
 
fakeFetch([
  {
    request: '/api/users',
    error
  }
]);
 
// this promise will get reject with `error`
fetch('/api/users').catch((err) => console.log(err));

Inducing delay for all the requests

fakeFetch({
  globalConfig: {
    delay: 3000
  },
  fakeConfigs: [
    {
      request: '/api/users/ameerthehacker',
      response: new Response(JSON.stringify({ name: 'Ameer Jhan' })),
      // local delay are given higher precedence
      delay: 5000
    }
  ]
});

Customize 404 response

If fakeFetch could not find any fake config for a given request then it will return a default 404 response, you can also customize it as shown below

const _404Response = new Response(undefined, {
      status: 404,
      statusText: 'User defined 404 response'
    });
 
fakeFetch({
  globalConfig: {
    _404Response
  },
  fakeConfigs: [...]
});

Show your support by ⭐️ the repo

License

MIT © Ameer Jhan

Readme

Keywords

none

Package Sidebar

Install

npm i fake-browser-fetch

Weekly Downloads

4

Version

0.0.2

License

MIT

Unpacked Size

11.2 kB

Total Files

5

Last publish

Collaborators

  • ameerthehacker