smartrequest/README.md

85 lines
3.2 KiB
Markdown
Raw Normal View History

2019-04-22 22:14:30 +00:00
# @pushrocks/smartrequest
2017-01-29 00:21:48 +00:00
dropin replacement for request
2019-04-22 22:14:30 +00:00
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartrequest)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartrequest)
* [github.com (source mirror)](https://github.com/pushrocks/smartrequest)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartrequest/)
2017-01-29 00:21:48 +00:00
## Status for master
2019-04-22 22:14:30 +00:00
[![build status](https://gitlab.com/pushrocks/smartrequest/badges/master/build.svg)](https://gitlab.com/pushrocks/smartrequest/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartrequest/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartrequest/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartrequest.svg)](https://www.npmjs.com/package/@pushrocks/smartrequest)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartrequest/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartrequest)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
2017-01-29 00:21:48 +00:00
## Usage
2018-06-13 20:34:49 +00:00
2017-01-29 00:21:48 +00:00
Use TypeScript for best in class instellisense.
2019-10-27 13:36:17 +00:00
### Features
* supports http
* supports https
* supports unix socks
* supports formData
* supports file uploads
* supports best practice keepAlive
* dedicated functions for working with JSON request/response cycles
* written in TypeScript
* continuously updated
* uses node native http and https modules
* used in modules like @pushrocks/smartproxy and @apiglobal/typedrequest
2019-10-27 13:38:12 +00:00
* commercial support available at [https://lossless.support](https://lossless.support)
2019-10-27 13:36:17 +00:00
2019-10-27 13:39:06 +00:00
> note: smartrequest uses the **native** node http/https modules under the hood (not the bloated one from npm)
2017-01-29 00:42:20 +00:00
2017-01-29 00:21:48 +00:00
```javascript
import * as smartrequest from 'smartrequest'
// simple post
2017-01-29 00:44:29 +00:00
let options: smartrequest.ISmartRequestOptions = { // typed options
2017-01-29 00:21:48 +00:00
headers: {
"Content-Type": "application/json"
"Authorization": "Bearer token"
},
requestBody: {
key1: 'value1',
key2: 3
}
}
2017-01-29 00:42:20 +00:00
smartrequest.post('https://example.com', options).then(res => {
console.log(res.status)
console.log(res.body) // if json, body will be parsed automatically
}).catch(err => {
console.log(err)
})
// also available
smartrequest.get(...)
smartrequest.put(...)
smartrequest.del(...)
// streaming
smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res => { // third arg = true signals streaming
console.log(res.status)
res.on('data', data => {
// do something with the data chunk here
}
res.on('end', () => {
// do something when things have ended
})
})
2017-01-29 00:21:48 +00:00
```
2019-04-22 22:14:30 +00:00
For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
2019-08-16 19:38:50 +00:00
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
2019-04-22 22:14:30 +00:00
2019-08-16 19:38:50 +00:00
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)