Code Monkey home page Code Monkey logo

idagio-shortwreck's Introduction

@idagio/shortwreck

A nice short wrapper for Wreck.

Usage

const ShortWreck = require('@idagio/shortwreck');

const ApiClient = ShortWreck({
  json: true
});

ApiClient.request("GET", "https://httpbin.org/get", (err, res, payload) => {
  if (err) {
    console.log(err);
    return;
  }

  console.log(res);
  console.log(payload);
});

API

new ShortWreck(options)

Takes the exact same options as wreck's defaults(options).

ShortWreck.prototype.request(method, uri /*, [options], callback */)

  • method - A string specifying the HTTP request method, defaulting to 'GET'.
  • uri - The URI of the requested resource.
  • options - Optional config object containing settings for both request and read operations. This will override the options initially passed to new ShortWreck(options).
  • callback - The callback function using the signature function (err, response, payload) where:
    • err - Any error that may have occurred during handling of the request.
    • response - The HTTP Incoming Message object, which is also a readable stream.
    • payload - The payload in the form of a Buffer or (optionally) parsed JavaScript object (JSON).

Returns an instance of the node.js ClientRequest object.

idagio-shortwreck's People

Contributors

miksago avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.