Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinnn/fettuccine
HTTP client with every imaginable option and small file size
https://github.com/shinnn/fettuccine
get http https lightweight promise request
Last synced: 26 days ago
JSON representation
HTTP client with every imaginable option and small file size
- Host: GitHub
- URL: https://github.com/shinnn/fettuccine
- Owner: shinnn
- License: isc
- Created: 2015-12-22T11:28:13.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-31T10:54:20.000Z (about 6 years ago)
- Last Synced: 2024-10-13T19:47:49.018Z (about 1 month ago)
- Topics: get, http, https, lightweight, promise, request
- Language: JavaScript
- Homepage:
- Size: 50.8 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fettuccine
[](https://www.npmjs.com/package/fettuccine)
[](https://travis-ci.org/shinnn/fettuccine)
[](https://coveralls.io/github/shinnn/fettuccine?branch=master)
[](https://david-dm.org/shinnn/fettuccine)
[](https://david-dm.org/shinnn/fettuccine#info=devDependencies)
A simplified HTTP client for [Node](https://nodejs.org/)
* with the [Promise API](https://promisesaplus.com/)
* and [every imaginable option](https://github.com/request/request#requestoptions-callback) thanks to [Request](https://github.com/request/request),
* nevertheless, keeping [small package size](https://github.com/shinnn/load-request-from-cwd-or-npm#why) by [economical module loading](https://github.com/shinnn/load-request-from-cwd-or-npm)
```javascript
const fettuccine = require('fettuccine');
(async () => {
const response = await fettuccine('https://api.github.com/users/isaacs/repos', {
qs: {sort: 'created'},
json: true
});
response.body[0]; //=> {id: 46883374, name: 'pseudomap', ...}
})();
```
## Installation
[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm).
```
npm install fettuccine
```
## API
```javascript
const fettuccine = require('fettuccine');
```
### fettuccine(*url* [, *options*])
*url*: `string` (URL to send a request)
*options*: `Object` (used as [`Request` options][request] with [`gzip`](https://github.com/request/request/blob/288f814e71efdd70f852888c1701c5cf3d177da5/request.js#L913-L928) defaulting to `true`)
Return: `Promise`
It makes an HTTP or HTTPS request to the given URL.
When the request finishes, it will be [*fulfilled*](https://promisesaplus.com/#point-26) with the [`http.IncomingMessage`](https://nodejs.org/api/http.html#http_http_incomingmessage) object with the additional [`body` property][request]:
> `response` body (`String` or `Buffer`, or JSON object if the `json` option is supplied)
When the request fails, it will be [*rejected*](https://promisesaplus.com/#point-30) with an error object (usually from [`http.ClientRequest`](https://nodejs.org/api/http.html#http_class_http_clientrequest) object).
### fettuccine.get()
Alias of [`fettuccine()`][fettucine].
### fettuccine.post(), fettuccine.put(), fettuccine.patch(), fettuccine.head(), fettuccine.delete()
Set `options.method` to the method name and call [`fettuccine()`][fettucine].
```javascript
const fettuccine = require('fettuccine');
// With `fettuccine()`
(async () => {
await fettuccine('https://awesome-webservice.com/api', {
method: 'POST',
body: imageBuffer
});
console.log('Uploaded an image.')
})();
// With `fettuccine.post()`
(async () => {
await fettuccine.post('https://awesome-webservice.com/api', {
body: imageBuffer
});
console.log('Uploaded an image.')
})();
```
### fettuccine.Fettuccine([*options*])
The [`Fettuccine` class](https://github.com/shinnn/fettuccine-class).
## License
[ISC License](./LICENSE) © 2018 Shinnosuke Watanabe
[request]: https://github.com/request/request#requestoptions-callback
[fettucine]: https://github.com/shinnn/fettuccine#fettuccineurl--options