agent-phin

---

> The ultra-lightweight Node.js HTTP client

This is a fork from Phin that adds support for HTTP agent.

Simple Usage

``javascript
const p = require('phin')

const res = await p('https://ethanent.me')

console.log(res.body)
`

Note that the above should be in an async context! phin also provides an unpromisified version of the library.

Install

`
npm install agent-phin
`

Why phin?

phin is trusted by some really important projects. The hundreds of contributors at Less, for example, depend on phin as part of their development process.

Also, phin is super lightweight. Like 99.8% smaller than request lightweight. To compare to other libraries, see phin vs. the Competition.

Quick Demos

Simple POST:

`js
await p({
url: 'https://ethanent.me',
method: 'POST',
data: {
hey: 'hi'
}
})
`

Using KeepAlive agent:

`js
const https = require('https');
const keepAliveAgent = new https.Agent({ keepAlive: true });

await p({
url: 'https://ethanent.me',
method: 'POST',
data: {
hey: 'hi'
},
agent: keepAliveAgent
})
`

Using agent for proxy:

`js
const HttpsProxyAgent = require('https-proxy-agent');

const proxy = 'http://localhost:8008';
const agent = new HttpsProxyAgent(proxy);

await p({
url: 'https://ethanent.me',
method: 'POST',
data: {
hey: 'hi'
},
agent: agent
})
`

Unpromisified Usage

`js
const p = require('phin').unpromisified

p('https://ethanent.me', (err, res) => {
if (!err) console.log(res.body)
})
`

Simple parsing of JSON:

`js
// (In async function in this case.)

const res = await p({
url: 'https://ethanent.me/name',
parse: 'json'
})

console.log(res.body.first)
`

Default options

`js
const ppostjson = p.defaults({
'method': 'POST',
'parse': 'json',
'timeout': 2000
})

// In async function...

const res = await ppostjson('https://ethanent.me/somejson')
// ^ An options object could also be used here to set other options.

// Do things with res.body?
``

Full Documentation

See the phin documentation.

phin vs. the Competition

phin is a very lightweight library, yet it contains all of the common HTTP client features included in competing libraries!

Here's a size comparison table:

Package | Size
--- | ---
request | 
superagent | 
isomorphic-fetch | 
axios | 
got | 
r2 | 
node-fetch | 
snekfetch | 
phin |