tinyreq

tinyreq

Tiny library for making http(s) requests.

:cloud: Installation

# Using npm
npm install --save tinyreq

# Using yarn
yarn add tinyreq

:bulb: ProTip: You can install the cli version of this module by running npm install --global tinyreq-cli (or yarn global add tinyreq-cli).

:clipboard: Example

const tinyreq = require("tinyreq");

// Make a request to example.com
tinyreq("http://example.com/", (err, body) => {
    console.log(err || body);
});

// Make a request with custom headers
// Using a promise
tinyreq({
    url: "http://example.com/"
  , headers: {
        "user-agent": "Crawler/1.0"
    }
}).then(body => {
    console.log(body);
}).catch(err => {
    console.log(err);
});

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

2. For bug reports and feature requests, open issues. :bug:

3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

tinyreq(options, callback)

Creates http(s) requests.

Params

• String|Object options: A string being the request url or an object containing the following fields:
• url (String): The request url.
• method (String): The request method.
• data (Object): The request POST data.
• encoding (String): The response encoding type.
• data_encoding (String): The request encoding type.
• Function callback: The callback function called (with error and data parameters).

Return

• EventEmitter An event emitter you can use for listening for the data, error and end events.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• bandcamp-scraper (by Simon Thiboutôt)—A scraper for https://bandcamp.com
• bnr (by Bloggify)—Access resources (e.g. exchange rates) provided by the National Bank of Romania.
• cheerio-req—An http request module sending back a Cheerio object.
• github-colors—GitHub colors and file extensions mapping
• google-font-downloader (by Bloggify)—Download Google fonts by providing the url
• jsonrequest—A tiny library for requesting and getting JSON resources.
• kequtwitch (by Nathan Lunde-Berry)—This is a node library for interfacing with twitch
• lwipify—Convert images in lwip objects.
• medivia-api (by Ethaan)—Medivia.org NodeJS API
• mun (by Matheus Alves)—Obter informações de municípios do brasileiros.
• page-changed—Call a function when the page body is changed.
• payiota (by Andy Lisac)—A Node.js wrapper around the Payiota.me API.
• tibia-api (by Ethaan)—NodeJS Tibia.com API
• tinyreq-cli—A cli tool for making http(s) requests. CLI for tinyreq.
• wrabbit (by jillix)—Wrap scripts by providing the wrapping function.

:scroll: License

MIT © Ionică Bizău