phn
v0.0.3
Published
a lightweight http client
Downloads
30
Maintainers
Readme
phn
A lightweight http client adapted from phin and centra.
install
npm i phn
usage
const phn = require("phn");
const res = await phn({
url: 'https://example.org'
});
options
url
- URL to requestmethod
- HTTP method, default:GET
headers
- HTTP headers objectquery
- Object to be added tourl
as query stringdata
- Request body; json, buffer or object containing form dataform
- object containing form datacore
- options passed on tohttp(s).request
parse
- parse response body asjson
orstring
followRedirects
- follow redirects iftrue
maxRedirects
- maximum number of redirects to follow, default: infinitestream
- return stream asres.stream
instead ofres.body
compression
- handle compression, acceptbr
,gzip
anddeflate
timeout
- request timeout in milliseconds
stream
consume http response as stream
const phn = require("phn");
const stream = await phn({
url: 'https://example.org/',
compression: true,
stream: true,
});
stream.pipe(/* ... */)
custom http(s) options
use a custom agent
const phn = require("phn");
const https = require("https");
const agent = new https.Agent({ keepAlive: true });
await phn({
url: 'https://example.org/',
core: { agent },
});
unpromisified
get a classic callback interface
const phn = require("phn").unpromisified;
phn('https://example.org/', (err, res) => {
if (!err) console.log(res.body);
});
defaults
set options for any subsequent request
const phn = require("phn").defaults({
method: 'POST',
parse: 'json',
timeout: 2000
});
const res = await phn('https://example.org/')
comparison
phn
is tiny and comes with no dependencies.
Package | Size --- | --- node-fetch | axios | request | superagent | undici | got | isomorphic-fetch | r2 | slim-fetch | phin | phn |
license
acknowledgement
phn
is a fork of phin and centra by Ethan Davis.