wreck

HTTP Client Utilities

5.1.0
Source
npm

Version published: 10 years ago

Weekly downloads: 137K; increased by26.5%

Maintainers: 2

Weekly downloads

Created: 10 years ago

What is wreck?

The 'wreck' npm package is a powerful HTTP client library for Node.js, designed to make HTTP requests and handle responses with ease. It is part of the hapi ecosystem and provides a simple API for making HTTP requests, handling redirects, and managing cookies.

What are wreck's main functionalities?

Making HTTP GET Requests

This feature allows you to make HTTP GET requests to a specified URL. The code sample demonstrates how to use Wreck to fetch data from a URL and log the response status code and payload.

const Wreck = require('wreck');

async function fetchData(url) {
  try {
    const { res, payload } = await Wreck.get(url);
    console.log('Response:', res.statusCode);
    console.log('Payload:', payload.toString());
  } catch (err) {
    console.error('Error:', err);
  }
}

fetchData('https://jsonplaceholder.typicode.com/posts/1');

Making HTTP POST Requests

This feature allows you to make HTTP POST requests with a payload. The code sample demonstrates how to use Wreck to send data to a URL and log the response status code and payload.

const Wreck = require('wreck');

async function postData(url, data) {
  try {
    const { res, payload } = await Wreck.post(url, { payload: data });
    console.log('Response:', res.statusCode);
    console.log('Payload:', payload.toString());
  } catch (err) {
    console.error('Error:', err);
  }
}

postData('https://jsonplaceholder.typicode.com/posts', { title: 'foo', body: 'bar', userId: 1 });

Handling Redirects

This feature allows you to handle HTTP redirects automatically. The code sample demonstrates how to use Wreck to follow up to 3 redirects when making a GET request.

const Wreck = require('wreck');

async function fetchWithRedirect(url) {
  try {
    const { res, payload } = await Wreck.get(url, { redirects: 3 });
    console.log('Response:', res.statusCode);
    console.log('Payload:', payload.toString());
  } catch (err) {
    console.error('Error:', err);
  }
}

fetchWithRedirect('http://example.com');

Managing Cookies

This feature allows you to manage cookies for your HTTP requests. The code sample demonstrates how to use Wreck to set a cookie and include it in a GET request.

const Wreck = require('wreck');

async function fetchWithCookies(url) {
  const jar = Wreck.jar();
  jar.setCookie('session=abc123', url);

  try {
    const { res, payload } = await Wreck.get(url, { cookies: jar });
    console.log('Response:', res.statusCode);
    console.log('Payload:', payload.toString());
  } catch (err) {
    console.error('Error:', err);
  }
}

fetchWithCookies('http://example.com');

Other packages similar to wreck

wreck Logo

HTTP Client Utilities

Lead Maintainer: Wyatt Preul

Usage

Basic

var Wreck = require('wreck');

Wreck.get('https://google.com/', function (err, res, payload) {
    /* do stuff */
});

Advanced

var Wreck = require('wreck');

var method = 'GET'; // GET, POST, PUT, DELETE
var uri    = 'https://google.com/';
var readableStream = Wreck.toReadableStream('foo=bar');

// all attributes are optional
var options = {
    payload:   readableStream || 'foo=bar' || new Buffer('foo=bar'),
    headers:   { /* http headers */ },
    redirects: 3,
    timeout:   1000,    // 1 second, default: unlimited
    maxBytes:  1048576, // 1 MB, default: unlimited
    rejectUnauthorized: true || false,
    downstreamRes: null,
    agent: null,         // Node Core http.Agent
    secureProtocol: 'SSLv3_method' // The SSL method to use
};

var optionalCallback = function (err, res) {

    /* handle err if it exists, in which case res will be undefined */
    
    // buffer the response stream
    Wreck.read(res, null, function (err, body) {
        /* do stuff */
    });
};

var req = Wreck.request(method, uri, options, optionalCallback);