README.zh-CN.md

ajax-fake

English|简体中文

ajax-fake可以拦截原生 ajax 请求，我们可以借助它做一些极客的事，例如模拟 ajax 响应数据、状态码、请求时间等

例子

import { fake, unfake } from 'ajax-fake'

const mockData = [
  {
    path: '/api/v1/article/list',
    method: 'GET',
    response: `{"success": true, "data": "hello", "code": 0}`,
  },
]

fake({
  // 开启force，原始XMLHttpRequest对象不会被更改
  force: true,
  // 请求匹配方法
  onRequestMatch: ({ requestMethod, requestUrl }) => {
    // 根据mockData查找匹配的请求
    const matchedItem = mockData.find((item) => {
      const { path, method } = item
      return requestMethod.toUpperCase() === method.toUpperCase() && requestUrl === path
    })
    if (matchedItem) {
      return {
        // 当matched为true时ajax-fake会模拟ajax请求
        matched: true,
        response: matchedItem.response,
        // 我们可以通过配置sendRealXhr在matched为true的情况依然可以发起真实ajax请求
        // 注意当sendRealXhr为true时，实际上会有两个请求，一个是模拟的请求，另一个是真实请求
        // 模拟的请求不会出现在Chrome Network 面板，真实请求是附加的，我们处理的还是模拟请求的结果
        // 这个配置是为了让请求更具有欺骗性
        sendRealXhr: true,
        status: 200,
        delay: 2000,
      }
    } else {
      return {
        // 当matched为false时，ajax-fake将发起真实ajax请求
        matched: false,
      }
    }
  },
})

// 取消ajax请求拦截
unfake()