{"id":18817845,"url":"https://github.com/vitorluizc/create-request","last_synced_at":"2025-10-28T13:46:15.224Z","repository":{"id":57275182,"uuid":"163129795","full_name":"VitorLuizC/create-request","owner":"VitorLuizC","description":"Apply interceptors to `fetch` and create a custom request function.","archived":false,"fork":false,"pushed_at":"2022-01-09T20:13:54.000Z","size":160,"stargazers_count":37,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T17:05:30.660Z","etag":null,"topics":["async","bili","fetch","fetch-api","http-client","https-client","intercept-fetch","interceptors","javascript","promise","request","request-promise","typescript","whatwg-fetch"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VitorLuizC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-26T03:00:20.000Z","updated_at":"2023-09-08T17:48:35.000Z","dependencies_parsed_at":"2022-09-16T11:12:17.357Z","dependency_job_id":null,"html_url":"https://github.com/VitorLuizC/create-request","commit_stats":null,"previous_names":["vitorluizc/intereq"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VitorLuizC%2Fcreate-request","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VitorLuizC%2Fcreate-request/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VitorLuizC%2Fcreate-request/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VitorLuizC%2Fcreate-request/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VitorLuizC","download_url":"https://codeload.github.com/VitorLuizC/create-request/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248795282,"owners_count":21162741,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","bili","fetch","fetch-api","http-client","https-client","intercept-fetch","interceptors","javascript","promise","request","request-promise","typescript","whatwg-fetch"],"created_at":"2024-11-08T00:13:39.352Z","updated_at":"2025-10-28T13:46:15.158Z","avatar_url":"https://github.com/VitorLuizC.png","language":"TypeScript","readme":"# `@bitty/create-request`\n\n![License](https://badgen.net/github/license/VitorLuizC/create-request)\n![Library minified size](https://badgen.net/bundlephobia/min/@bitty/create-request)\n![Library minified + gzipped size](https://badgen.net/bundlephobia/minzip/@bitty/create-request)\n\nApply interceptors to `fetch` and create a custom request function.\n\n- :zap: Dependency free and pretty small, **0.3KB** (minified + gzipped);\n- :label: Well type defined with TypeScript (with _generics_);\n- :package: There are ESM, CommonJS and UMD distributions;\n\n## Installation\n\nThis library is published in the NPM registry and can be installed using any compatible package manager.\n\n```sh\nnpm install @bitty/create-request --save\n\n# Use the command below if you're using Yarn.\nyarn add @bitty/create-request\n```\n\n## Usage\n\n`@bitty/create-request` is curry function, which applies interceptors to `fetch` and returns a new request function.\n\n```ts\nimport createRequest from '@bitty/create-request';\n\ntype Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';\n\nconst request = createRequest(window.fetch, {\n  onRequest: (method: Method, route: string, data: any = undefined) =\u003e ({\n    url: 'https://api.example.com' + route,\n    body: JSON.stringify(data),\n    method,\n    headers: { 'Content-Type': 'application/json' }\n  }),\n  onResponse: (response: Response) =\u003e {\n    if (response.status === 403)\n      throw new Error('Authorization error.');\n    return response.json();\n  },\n  onError: (error:? Error) =\u003e {\n    sentry.captureException(error);\n    return Promise.reject(message);\n  }\n});\n\nrequest('POST', '/user', {\n  name: 'Vitor'\n})\n  .then((response) =\u003e response.success \u0026\u0026 alert('User was created!'));\n```\n\n### Interceptors\n\n- **`onError`**\n\n  ```ts\n  onError?: (reason?: Error) =\u003e Promise\u003cnever\u003e;\n  ```\n\n  Handle request and response errors.\n\n- **`onRequest`**\n\n  ```ts\n  onRequest?: \u003cA extends any[] = [RequestOptions]\u003e(...params: A) =\u003e RequestOptions;\n  ```\n\n  Handle request and define request arguments. `A` generic type defines returned `request` function arguments type.\n\n  ![`onRequest` GIF](https://user-images.githubusercontent.com/9027363/50517033-52f98580-0a95-11e9-9deb-0f63e9f56dbf.gif)\n\n- **`onRequestError`**\n\n  ```ts\n  onRequestError?: (reason?: Error) =\u003e Promise\u003cnever\u003e;\n  ```\n\n  Handle request errors. Overwrites `onError` handling request errors.\n\n- **`onResponse`**\n\n  ```ts\n  onResponse?: \u003cR = Response\u003e(response: R) =\u003e R | PromiseLike\u003cR\u003e;\n  ```\n\n  Handle response and define the request return. `R` generic type defines returned `request` function result type.\n\n  ![`onResponse` GIF](https://user-images.githubusercontent.com/9027363/50516780-e92cac00-0a93-11e9-963f-c59095af655a.gif)\n\n- **`onResponseError`**\n\n  ```ts\n  onResponseError?: (reason?: Error) =\u003e Promise\u003cnever\u003e;\n  ```\n\n  Handle response errors. Overwrites `onError` handling response errors.\n\n### Usage on unsupported browsers\n\n[Do I support `fetch`?](https://caniuse.com/#feat=fetch)\n\nOlder browsers don't support `Fetch API`, but you can use [`unfetch`](https://github.com/developit/unfetch) or other polyfill to achieve it.\n\n```js\nimport fetch from 'unfetch';\nimport createRequest from '@bitty/create-request';\n\nexport default createRequest(fetch, {\n  onRequest: (options) =\u003e ({\n    ...options,\n    headers: {\n      ...options.headers,\n      'Content-Type': 'application/json'\n    }\n  }),\n  onResponse: (response) =\u003e response.json()\n});\n```\n\n### Usage on Node.js\n\nNode environment does not provide global `fetch` function, but you can use [`node-fetch`](https://github.com/bitinn/node-fetch) to achieve it.\n\n```js\nconst fetch = require('node-fetch');\nconst createRequest = require('@bitty/create-request');\n\nmodule.exports = createRequest(fetch, {\n  onResponse (response) {\n    return response.json();\n  }\n});\n```\n\n## License\n\nReleased under [MIT License](./LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitorluizc%2Fcreate-request","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvitorluizc%2Fcreate-request","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitorluizc%2Fcreate-request/lists"}