phin

What is phin?

The phin npm package is a lightweight HTTP client designed for simplicity and minimalism. It is used for making HTTP requests from Node.js environments. It supports promises and can handle various types of requests such as GET, POST, and more.

What are phin's main functionalities?

Simple HTTP GET requests

This code sample demonstrates how to perform a simple HTTP GET request to a specified URL using phin.

const phin = require('phin')

phin('https://example.com', (err, res) => {
  if (err) throw err
  console.log(res.body)
})

HTTP POST requests with JSON

This code sample shows how to perform an HTTP POST request with JSON data using phin.

const phin = require('phin')

const options = {
  url: 'https://example.com/post',
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  data: { key: 'value' }
}

phin(options, (err, res) => {
  if (err) throw err
  console.log(res.body)
})

Promisified HTTP requests

This code sample illustrates how to use phin with promises to make asynchronous HTTP requests.

const phin = require('phin').promisified

async function makeRequest() {
  try {
    const res = await phin('https://example.com')
    console.log(res.body)
  } catch (err) {
    console.error(err)
  }
}

makeRequest()

Other packages similar to phin

axios

Axios is a popular HTTP client for the browser and Node.js. It supports promises by default and has a wide range of features including interceptors, automatic transforms for JSON data, and client-side protection against XSRF. It is more feature-rich compared to phin but also larger in size.

got

Got is another HTTP request library for Node.js that is designed to be more user-friendly and powerful than the built-in http module. It supports streams, advanced timeout handling, and instances with custom defaults. It is more comprehensive than phin but also more complex.

node-fetch

node-fetch is a light-weight module that brings the Fetch API to Node.js. It aims to provide a consistent API with the browser's fetch function. It is similar to phin in terms of simplicity but follows the Fetch API standards.

superagent

Superagent is a small progressive client-side HTTP request library. It has a fluent API that allows chaining of methods to configure requests, and it can be extended with plugins. It is more feature-rich than phin and has a different API design focused on chaining methods.

README

phin

Ultra-simple, lightweight, dependency-free Node.JS HTTP request client

---

Simple Usage

For a simple GET request.

var p = require("phin");

p("https://www.ony.io", function(err, body, response) {
	if (!err) console.log(body);
});

Installation

npm install phin

Demonstrations

GET request with custom headers

p({
	"url": "https://ony.io",
	"headers": {
		"User-Agent": "phin"
	}
})

POST request with data

p({
	"url": "https://ony.io",
	"method": "POST",
	"port": 8080,
	"data": JSON.stringify({
		"name": "John Doe"
	})
}, function(err, body, response) {
	if (!err) console.log("Sent data!");
});

GET request with authorization using auth option

p({
	"url": "https://ony.io:8080",
	"auth": "ethan:letmein"
}, function(err, body, response) {
	if (!err) console.log(body);
});

GET request with authorization through url

p({
	"url": "https://ethan:[e-mail]:8080"
}, function(err, body, response) {
	if (!err) console.log(body);
});

---

API

(options, callback)

• options required - {} - object containing request options OR string URL to send GET request to
  • url required - String - URL to request (Can include port, auth. These will be used if their respective options are not present.)
  • method - String - Default: 'GET' - Request method. Ex. 'GET'
  • port - Integer (or integer as string) - Default: For HTTP, 80. For HTTPS, 443. - Request port
  • headers - Object - Request headers
  • data - String / non-circular JS object - Request data (request body)
  • auth - String - Authorization in 'user:pass' format
• callback required - function(err, body, response) {} - callback method
  • err - String / null - Is null if no error occurs during request.
  • body - String - Response content
  • response - HTTP / HTTPS response object. See Node.JS HTTP docs - HTTP.serverResponse class.

License (MIT)

Copyright 2017 Ethan Davis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.