jsonrequest
Version:
A tiny library for requesting and getting JSON resources.
242 lines (92 loc) • 5.16 kB
Markdown
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
# jsonrequest
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://travis-ci.org/IonicaBizau/jsonrequest/) [](https://www.npmjs.com/package/jsonrequest) [](https://www.npmjs.com/package/jsonrequest) [](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
> A tiny library for requesting and getting JSON resources.
## :cloud: Installation
```sh
# Using npm
npm install --save jsonrequest
# Using yarn
yarn add jsonrequest
```
## :clipboard: Example
```js
// Dependencies
const request = require("jsonrequest");
request({
url: "https://api.github.com/users/IonicaBizau",
headers: {
"User-Agent": "JsonRequest"
}
}).then(data => {
console.log(data);
// => {
// "login": "IonicaBizau",
// "id": 2864371,
// "avatar_url": "https://avatars.githubusercontent.com/u/2864371?v=3",
// "gravatar_id": "",
// "url": "https://api.github.com/users/IonicaBizau",
// "html_url": "https://github.com/IonicaBizau",
// "followers_url": "https://api.github.com/users/IonicaBizau/followers",
// ...
// }
}).catch(err => {
console.error(err);
});
// Make a request to GitHub API
request("https://ionicabizau.net/api/articles", (err, data) => {
console.log(err || data);
});
```
## :question: Get Help
There are few ways to get help:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). 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](https://www.codementor.io/johnnyb). :rocket:
## :memo: Documentation
### `jsonRequest(options, data, callback)`
Creates the http(s) request and parses the response.
#### Params
- **String|Object** `options`: A string representing the request url or an object passed to the `tinyreq` function.
- **Object** `data`: The request data object.
- **Function** `callback`: The callback function.
#### Return
- **Object** The request object.
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
## :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:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—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:
- `bible-english`
- `bnotify`
- `calendarific`
- `coindesk.js`
- `fb-token-updater`
- `gh.js`
- `homebridge-domotiga`
- `ipinfo`
- `npm-user-pkgs`
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW