https://github.com/bfncs/request-fluture
:butterfly: Simple HTTP requests with Fluture and request.
https://github.com/bfncs/request-fluture
fantasy-land fluture functional http https monad promise request xhr
Last synced: about 2 months ago
JSON representation
:butterfly: Simple HTTP requests with Fluture and request.
- Host: GitHub
- URL: https://github.com/bfncs/request-fluture
- Owner: bfncs
- License: mit
- Created: 2017-09-05T17:09:03.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-05T21:34:28.000Z (over 6 years ago)
- Last Synced: 2025-07-22T13:13:59.742Z (3 months ago)
- Topics: fantasy-land, fluture, functional, http, https, monad, promise, request, xhr
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/request-fluture
- Size: 216 KB
- Stars: 17
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# request-fluture
[](https://travis-ci.org/bfncs/request-fluture)
Simple HTTP requests with [Flutures](https://github.com/fluture-js/Fluture) and [request](https://github.com/request/request).
This is a wrapper around `request` to offer a Fluture API (instead of callback- or promise-based).
## Install
```bash
# If you are using npm
npm install request-fluture request fluture
# If you are using yarn
yarn add request-fluture request fluture
```
## Usage
Call the exported function with either a `url` or an `options` object [according to the `request` docs](https://github.com/request/request#requestoptions-callback).
It returns a `Fluture` for your pending request. You can use the whole [`Fluture API`](https://github.com/fluture-js/Fluture#documentation) to do stuff with your result.
```js
const request = require('request-fluture');
request('http://example.com')
.fork(
error => console.error('Oh no!', error),
response => console.log('Got a response!', response)
);
```
Fetch data from a REST API and extract some specific data.
```js
const request = require('request-fluture');
const { encase } = require('fluture');
request({url: 'https://api.github.com/users/github', headers: {'User-Agent': 'request-fluture'}})
.map(res => res.body)
.chain(encase(JSON.parse))
.map(user => user.name)
.fork(
console.error,
name => console.log(`The requested username is ${name}.`)
);
```
You can cleanly [`cancel`](https://github.com/fluture-js/Fluture#cancellation) the request fluture anytime after using a [consuming function](https://github.com/fluture-js/Fluture#consuming-futures) like `fork` on it:
```js
const request = require('request-fluture');
const cancel = request('http://example.com')
.fork(console.error, console.log);
// Cancel the request
setTimeout(cancel, 1000);
```
This is for example also used to cleanly cancel requests whose results are not interesting anymore like when using [`race`](#race), saving your precious bandwidth.
## Examples
### Race
[Race](https://github.com/fluture-js/Fluture#race) multiple requests against each other and resolve to the first settled request.
```js
const Future = require('fluture');
const request = require('request-fluture');
// Race two requests against each other…
request('http://example.com/foo')
.race(request('http://example.com/bar'))
.fork(console.error, console.log);
// …or race an array of requests
const first = futures => futures.reduce(Future.race, Future.never);
first([
request('http://example.com/foo'),
request('http://example.com/bar'),
request('http://example.com/baz')
])
.fork(console.error, console.log);
```
You can easily implement a timeout for your requests with this:
```js
const Future = require('fluture');
const request = require('request-fluture');
request('http://example.com/foo')
.race(Future.rejectAfter(1000, 'Timeout'))
.fork(console.error, console.log);
```
### Parallel requests
Execute five requests with maximum `5` requests in parallel.
```js
const Future = require('fluture');
const request = require('request-fluture');
const tenRequests = Array.from(Array(10).keys())
.map(resource => request(`http://example.com/${resource}`));
Future.parallel(5, tenRequests)
.fork(
console.error,
results => { results.forEach(console.log); }
);
```
## Prior art
This is just a slight extension of a [Gist](https://gist.github.com/Avaq/e7083ffc7972bb1d4c88239b51eb4a79) by @Avaq.