A module for modern HTTP/HTTPS requests with support for form data, file uploads, JSON, binary data, streams, and more.
Go to file
2019-09-28 22:27:10 +02:00
test fix(core): update 2019-09-28 22:27:09 +02:00
ts fix(core): update 2019-09-28 21:33:13 +02:00
.gitignore fix(core): update 2019-08-16 21:38:50 +02:00
.gitlab-ci.yml fix(core): update 2019-09-08 17:49:32 +02:00
npmextra.json fix(core): update 2019-04-23 00:14:30 +02:00
package-lock.json 1.1.31 2019-09-28 22:27:10 +02:00
package.json 1.1.31 2019-09-28 22:27:10 +02:00
README.md fix(core): update 2019-08-16 21:38:50 +02:00
tslint.json fix(core): update 2019-04-23 00:14:30 +02:00

@pushrocks/smartrequest

dropin replacement for request

Status for master

build status coverage report npm downloads per month Known Vulnerabilities TypeScript node JavaScript Style Guide

Usage

Use TypeScript for best in class instellisense.

note: smartrequest uses the native node request module under the hood (not the one from npm)

import * as smartrequest from 'smartrequest'

// simple post
let options: smartrequest.ISmartRequestOptions = { // typed options
    headers: {
        "Content-Type": "application/json"
        "Authorization": "Bearer token"
    },
    requestBody: {
        key1: 'value1',
        key2: 3
    }
}

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
    })
})

For further information read the linked docs at the top of this readme.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

repo-footer