\n\n# Mochi Mock \n\nThis package is used to mock json file normally returned by backend apis\n\n## 🌈 Installation\n\n```bash\n// npm\nnpm i @consolelabs/mochi-mock\n\n// yarn\nyarn add @consolelabs/mochi-mock\n\n// pnpm\npnpm add @consolelabs/mochi-mock\n```\n\n## 🚀 Usage\n\n### 1. Sync data\n\nFirst, sync the mock data to your local project, this should clone/overwrite the remote data mock repo\n\n```bash\n// npm or yarn\nnpx mochi-mock -i\n\n// pnpm\npnpm exec mochi-mock -i\n```\n\n### 2. Spy request\n\n```javascript\nimport spyRequest from \"@consolelabs/mochi-mock\";\n// or\nconst spyRequest = require(\"@consolelabs/mochi-mock\");\n\n// ensure that mocker only runs in development\nif (process.env.NODE_ENV === \"development\") {\n spyRequest();\n}\n```\n\n### 3. Mock response\n\n#### Method 1 (recommended, requires [wretch](https://github.com/elbywan/wretch) package)\n\nRegister a new addon for your wretch instance\n\n```javascript\nimport { MockAddon } from \"@consolelabs/mochi-mock\";\nimport wretch from \"@consolelabs\";\n\nconst api = wretch().addon(MockAddon);\n\n// somewhere else in your business logic\nconst data = api\n .mock(\"path/to/json/mock/file\", { query: \"optional\" })\n .get()\n .json();\n```\n\n#### Method 2\n\nThe other way is to attach a custom header called `X-Mochi-Mock` with the json file as the header's value (this is also how the mocker works under the hood)\n\n## ❓ FAQ\n\n### Do I need to follow some kind of format in my mock json file?\n\nNo, just use regular objects/list at the root, the response returned by the mocker will be converted to a format that is the same from a real api\n\n### Does the mocker support query string?\n\nYes, and there are also some reserved keys like `page` and `size` that are used for pagination. Anyother key/value pair is treated as filtering value, for example, this file:\n\n```json\n[\n {\n \"id\": 1,\n \"name\": \"john\"\n },\n {\n \"id\": 2,\n \"name\": \"ben\"\n }\n]\n```\n\nmocking this file with query string `?name=john` will only return list with 1 element\n\n## 🤝 Contributing\n\nIf you happen to change the mock data, kindly submit a PR with the changes so the team can review it\n","readmeFilename":"README.md"}