phin logo

--- > The lightweight Node.js HTTP client [Full documentation](https://ethanent.github.io/phin/global.html) | [GitHub](https://github.com/ethanent/phin) | [NPM](https://www.npmjs.com/package/phin) ## Deprecated This package is deprecated and should not be used. Please see [#91](https://github.com/ethanent/phin/issues/91) for more information. ## 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 phin ``` ## Why Phin? Phin is relied upon by important projects and large companies. The hundreds of contributors at [Less](https://github.com/less/less.js), for example, depend on Phin as part of their development process. Also, Phin is very lightweight. To compare to other libraries, see [Phin vs. the Competition](https://github.com/ethanent/phin/blob/master/README.md#phin-vs-the-competition). ## Quick Demos Simple POST: ```js await p({ url: 'https://ethanent.me', method: 'POST', data: { hey: 'hi' } }) ``` ### 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? ``` ### Custom Core HTTP Options Phin allows you to set [core HTTP options](https://nodejs.org/api/http.html#http_http_request_url_options_callback). ```js await p({ 'url': 'https://ethanent.me/name', 'core': { 'agent': myAgent // Assuming you'd already created myAgent earlier. } }) ``` ## Full Documentation There's a lot more which can be done with the Phin library. See [the Phin documentation](https://ethanent.github.io/phin/global.html). ## 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 | [![request package size](https://packagephobia.now.sh/badge?p=request)](https://packagephobia.now.sh/result?p=request) superagent | [![superagent package size](https://packagephobia.now.sh/badge?p=superagent)](https://packagephobia.now.sh/result?p=superagent) got | [![got package size](https://packagephobia.now.sh/badge?p=got)](https://packagephobia.now.sh/result?p=got) axios | [![axios package size](https://packagephobia.now.sh/badge?p=axios)](https://packagephobia.now.sh/result?p=axios) isomorphic-fetch | [![isomorphic-fetch package size](https://packagephobia.now.sh/badge?p=isomorphic-fetch)](https://packagephobia.now.sh/result?p=isomorphic-fetch) r2 | [![r2 package size](https://packagephobia.now.sh/badge?p=r2)](https://packagephobia.now.sh/result?p=r2) node-fetch | [![node-fetch package size](https://packagephobia.now.sh/badge?p=node-fetch)](https://packagephobia.now.sh/result?p=node-fetch) phin | [![phin package size](https://packagephobia.now.sh/badge?p=phin)](https://packagephobia.now.sh/result?p=phin)

	Stars	Issues	Version	Updated	Created
axios	104,045	695	1.6.8	a month ago	10 years ago
file-saver			2.0.5	3 years ago	8 years ago
phin	575	24	3.7.1	17 days ago	10 years ago
superagent	16,539	172	9.0.1	4 days ago	13 years ago
wget-improved	49	0	3.4.0	10 months ago	9 years ago

axios vs file-saver vs phin vs superagent vs wget-improved

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past