{"id":19312129,"url":"https://github.com/bigcommerce/request-sender-js","last_synced_at":"2025-04-22T15:31:56.665Z","repository":{"id":41124945,"uuid":"115055913","full_name":"bigcommerce/request-sender-js","owner":"bigcommerce","description":"HTTP request client for browsers","archived":false,"fork":false,"pushed_at":"2025-04-01T10:50:03.000Z","size":824,"stargazers_count":3,"open_issues_count":5,"forks_count":10,"subscribers_count":63,"default_branch":"master","last_synced_at":"2025-04-02T00:51:19.665Z","etag":null,"topics":["ajax","javascript","xhr"],"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/bigcommerce.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-12-21T23:22:40.000Z","updated_at":"2025-01-28T12:15:59.000Z","dependencies_parsed_at":"2024-03-04T05:30:04.254Z","dependency_job_id":"f6c73c9f-064a-4266-9a2b-15e420255a19","html_url":"https://github.com/bigcommerce/request-sender-js","commit_stats":{"total_commits":98,"total_committers":12,"mean_commits":8.166666666666666,"dds":0.5816326530612245,"last_synced_commit":"4755a5ac5951499e62aa629b2e26d33e41d15148"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Frequest-sender-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Frequest-sender-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Frequest-sender-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Frequest-sender-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigcommerce","download_url":"https://codeload.github.com/bigcommerce/request-sender-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250267421,"owners_count":21402477,"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":["ajax","javascript","xhr"],"created_at":"2024-11-10T00:32:57.757Z","updated_at":"2025-04-22T15:31:56.389Z","avatar_url":"https://github.com/bigcommerce.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RequestSender\n\nA simple library for sending HTTP requests.\n\n## Usage\n\nTo send a HTTP request.\n\n```js\nimport { createRequestSender } from '@bigcommerce/request-sender';\n\nconst requestSender = createRequestSender();\n\n// GET request\nrequestSender.get('/foobars')\n    .then(({ body }) =\u003e console.log(body));\n\n// POST request\nrequestSender.post('/foobars', { body: { name: 'Foobar' } })\n    .then(({ body }) =\u003e console.log(body));\n```\n\nTo cancel a pending request\n\n```js\nimport { createRequestSender, createTimeout } from '@bigcommerce/request-sender';\n\nconst timeout = createTimeout(100);\nconst requestSender = createRequestSender();\n\nrequestSender.get('/foobars', { timeout })\n    .catch(({ status }) =\u003e console.log(status));\n\ntimeout.cancel();\n```\n\n## API\n\n### createRequestSender()\n\nTo create a new instance of `RequestSender`.\n\n### createTimeout(delay: number?)\n\nTo create a new instance of `Timeout`. If `delay` is defined, the instance will automatically timeout after the specified period. Otherwise, it remains inactive until `complete()` is called.\n\n### RequestSender\n#### sendRequest(url: string, options: RequestOptions): Promise\u003cResponse\u003e\n#### get(url: string, options: RequestOptions): Promise\u003cResponse\u003e\n#### post(url: string, options: RequestOptions): Promise\u003cResponse\u003e\n#### put(url: string, options: RequestOptions): Promise\u003cResponse\u003e\n#### patch(url: string, options: RequestOptions): Promise\u003cResponse\u003e\n#### delete(url: string, options: RequestOptions): Promise\u003cResponse\u003e\n\nTo submit a HTTP request using `GET`, `POST`, `PUT`, `PATCH` or `DELETE` method. Alternatively, you can call `sendRequest` and specify the request method as an argument.\n\n### Timeout\n#### complete(): void;\n\nTo manually complete a timeout.\n\n### RequestOptions\n#### body: any?\nRequest payload.\nDefault: `null`\n\n#### encodeParams: boolean?\nURL encodes params.\nDefault: `true`\n\n#### headers: Object?\nRequest headers.\nDefault: `{\n    'Accept': 'application/json, text/plain, */*',\n    'Content-Type': 'application/json',\n}`\n\n#### params: Object?\nURL parameters. They get serialized as a query string.\nDefault: `null`\n\n#### method: string?\nRequest method. It's ignored if calling one of the convenience methods (`get`, `post` etc...).\nDefault: `GET`\n\n#### credentials: boolean?\nSame as `XMLHttpRequest.withCredentials`.\nDefault: `true`\n\n#### timeout: Timeout?\nDefine if wish to timeout a request.\nDefault: `null`\n\n### Response\n\n#### body: any\nResponse body.\nDefault: `null`\n\n#### headers: Object\nResponse headers.\nDefault: `{}`\n\n#### status: number?\nResponse status code. Return `0` if the request is cancelled.\nDefault: `undefined`\n\n#### statusText: string?\nResponse status text.\nDefault: `undefined`\n\n## Development\n\nSome useful commands\n\n```sh\n# To test\nnpm test\n\n# To lint\nnpm run lint\n\n# To release\nnpm run release\n```\n\nFor more commands, please see `package.json`\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Frequest-sender-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigcommerce%2Frequest-sender-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Frequest-sender-js/lists"}