{"bugs":{"url":"https://github.com/lukeed/httpie/issues"},"dist":{"shasum":"911d24765b846d3e83009dadec5270ef6555caa6","tarball":"https://registry.npmjs.org/httpie/-/httpie-2.0.0-next.10.tgz","fileCount":16,"integrity":"sha512-yp+T0Skk5JAW57YzW098fL8zK+Cu4KDt53jUKq+Lmc+ObPZ+USLbOGTaRJFbknuLqmYav6QCwMGy1ZmKOb/aVQ==","signatures":[{"sig":"MEYCIQDdSwO7F8AA7DAEKqAKqy9hlCwnLEP4lINTMsvFfHVnHQIhAPhWWfMWVjON0+9RfY01nqCF6/aJUy8Q4pSx5ISKDdeu","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":25928,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfPNKvCRA9TVsSAnZWagAAdmwP/21bE5XM4VbpehBI1RiY\nlcVs4eypx5OVrCWy5akeRZEz3Ry1yZs7vIJEyP8K1GO7pyQQjJB7tulQBReA\nRmGF6lDVc06bE/AGOsovkUgNylAlLPe2S7B5j1zYqsGk6BsQDpDgHiddUtFb\neim3efI3AR1caYzlw7wvBEi6eWV+T7GEbiIrJHLZQ2pCZTxdzTcjWvl58S1f\nEb7qT8b4kov5z+be0DEKXcQ+y/0TuTNNr7FtomHpwCh4kjWyAGMGKgiNBF4L\nrtF82eGscSK5MKr6c2hwLX3N9u051FjhAo04f6XFcFttGxk1++6tY+RIS9CM\nykPyD3mecz9AS7hSHwLnLNYQvbjwO6MIwLFP0x2QrM69SMxuoO9sy2Pz/KRr\n0d1oxksyBvFM9uMtWBiJLPUxdMjbAGrQ4PIPg/ECpLQaOdM1Ww9jWgPXbH+f\nEHANGb0dl2m2kTn4OjjaPrizC3C8GDsnLcsE+0NjgQ1K68ZC6yb6qliNls0N\nX6bGwKSU7XueMVmqk1uK/ll/0kIM5qOYLlsyEsYNHu/adKul4F/nWJMLjzYP\nn/Q3y1ypkC+qYc5PfnwyS8/xckLaAw1WGCSfDqunYUjeRVcK4Stf1fDEqJu+\nC0IQobKtShH5KC4wD5mP5LFjpKfuCg85QkelTXvAKYI7nOZggsY6xqMB+Rmn\nz9AI\r\n=Yr11\r\n-----END PGP SIGNATURE-----\r\n"},"main":"node/index.js","name":"httpie","modes":{"xhr":"src/xhr.js","node":"src/node.js","fetch":"src/fetch.js"},"types":"index.d.ts","unpkg":"xhr/index.min.js","author":{"url":"https://lukeed.com","name":"Luke Edwards","email":"luke.edwards05@gmail.com"},"module":"node/index.mjs","readme":"\n
![\"httpie\"](\"logo.png\")
\n
A Node.js and browser HTTP client as easy as pie!
\n\n## Features\n\n* `Promise`- based HTTP requestor\n* Works with HTTP and HTTPS protocols\n* Automatically handles JSON requests and responses\n* Extremely lightweight with **no dependencies** 678 bytes!\n* Includes aliases for common HTTP verbs: `get`, `post`, `put`, `patch`, and `del`\n\nAdditionally, this module is delivered as:\n\n* **ES Module**: [`dist/httpie.mjs`](https://unpkg.com/httpie/dist/httpie.mjs)\n* **CommonJS**: [`dist/httpie.js`](https://unpkg.com/httpie/dist/httpie.js)\n\n\n## Install\n\n```\n$ npm install --save httpie\n```\n\n\n## Usage\n\n> **Note:** The `async` syntax is for demo purposes – you may use Promises in a Node 6.x environment too!\n\n```js\nimport { get, post } from 'httpie';\n\ntry {\n const { data } = await get('https://pokeapi.co/api/v2/pokemon/1');\n\n // Demo: Endpoint will echo what we've sent\n const res = await post('https://jsonplaceholder.typicode.com/posts', {\n body: {\n id: data.id,\n name: data.name,\n number: data.order,\n moves: data.moves.slice(0, 6)\n }\n });\n\n console.log(res.statusCode); //=> 201\n console.log(res.data); //=> { id: 1, name: 'bulbasaur', number: 1, moves: [{...}, {...}] }\n} catch (err) {\n console.error('Error!', err.statusCode, err.message);\n console.error('~> headers:', err.headers);\n console.error('~> data:', err.data);\n}\n```\n\n\n## API\n\n### send(method, url, opts={})\nReturns: `Promise`\n\nAny `httpie.send` request (and its aliases) will always return a Promise.\n\nIf the response's `statusCode` is 400 or above, this Promise will reject with a formatted error – see [Error Handling](#error-handling). Otherwise, the Promise will resolve with the full [`ClientRequest`](https://nodejs.org/api/http.html#http_class_http_clientrequest) stream.\n\nThe resolved response will receive a new `data` key, which will contain the response's full payload. Should the response return JSON content, then `httpie` will parse it and the `res.data` value will be the resulting JSON object!\n\n#### method\nType: `String`\n\nThe HTTP method name – it must be uppercase!\n\n#### url\nType: `String` or [`URL`](https://nodejs.org/api/url.html#url_the_whatwg_url_api)\n\nIf `url` is a string, it is automatically parsed with [`url.parse()`](https://nodejs.org/api/url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost) into an object.\n\n#### opts.body\nType: `Mixed`
\nDefault: `undefined`\n\nThe request's body, can be of any type!\n\nAny non-`Buffer` objects will be converted into a JSON string and the appropriate [`Content-Type`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type) header will be attached.\n\nAdditionally, `httpie` will _always_ set a value for the [`Content-Length`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Length) header!\n\n#### opts.headers\nType: `Object`
\nDefault: `{}`\n\nThe custom headers to send with your request.\n\n#### opts.redirect\nType: `Boolean`
\nDefault: `true`\n\nWhether or not redirect responses should be followed automatically.\n\n> **Note:** This may only happen with a 3xx status _and_ if the response had a [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location) header.\n\n#### opts.reviver\nType: `Function`
\nDefault: `undefined`\n\nAn optional function that's passed directly to [`JSON.parse`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Parameters), allowing you transform aspects of the response data before the `httpie` request resolves.\n\n> **Note:** This will _only_ run if `httpie` detects that JSON is contained in the response!\n\n#### opts.timeout\nType: `Integer`
\nDefault: `undefined`\n\nThe time, in milliseconds, before automatically terminating the request.\n\nWhen the request exceeds this limit, `httpie` rejects with an `err`, adding a truthy `err.timeout` value.\n\n> **Important:** There is a slight behavioral difference between the Node & browser versions!
\nIn the server, the `timeout` value _does not propagate_ to any redirects.
\nIn the browser, the `timeout` value _will not_ reset during redirects.\n\n#### opts.withCredentials\nType: `Boolean`
\nDefault: `false`\n\nWhether or not cross-site requests should include credentials (such as cookies).
\nThis value is passed directly to [`XMLHttpRequest.withCredentials`](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials).\n\n**Important**: This is for the **browser version** only!\n\n\n\n### get(url, opts={})\n> Alias for [`send('GET', url, opts)`](#sendmethod-url-opts).\n\n### post(url, opts={})\n> Alias for [`send('POST', url, opts)`](#sendmethod-url-opts).\n\n### put(url, opts={})\n> Alias for [`send('PUT', url, opts)`](#sendmethod-url-opts).\n\n### patch(url, opts={})\n> Alias for [`send('PATCH', url, opts)`](#sendmethod-url-opts).\n\n### del(url, opts={})\n> Alias for [`send('DELETE', url, opts)`](#sendmethod-url-opts).\n\n\n## Error Handling\n\nAll responses with `statusCode >= 400` will result in a rejected `httpie` request. When this occurs, an Error instance is formatted with complete information:\n\n* `err.message` – `String` – Identical to `err.statusMessage`;\n* `err.statusMessage` – `String` – The response's `statusMessage` value;\n* `err.statusCode` – `Number` – The response's `statusCode` value;\n* `err.headers` – `Object` – The response's `headers` object;\n* `err.data` – `Mixed` – The response's payload;\n\nAdditionally, errors that are a result of a timeout expiration will have a truthy `err.timeout` value.\n\n> **Important:** The error's `data` property may also be parsed to a JSON object, according to the response's headers.\n\n```js\nimport { get } from 'httpie';\n\nget('https://example.com/404').catch(err => {\n console.error(`(${err.statusCode}) ${err.message}`)\n console.error(err.headers['content-type']);\n console.error(`~> ${err.data}`);\n});\n//=> \"(404) Not Found\"\n//=> \"text/html; charset=UTF-8\"\n//=> ~> \\n\\n ![\"CI\"](\"https://github.com/lukeed/httpie/workflows/CI/badge.svg\"){kind=icon}
\n