File size: 2,934 Bytes
bf237c2 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
<p align="center" style="text-align: center;"><img src="https://github.com/ethanent/centra/blob/master/media/centraLogo.png?raw=true" width="400"/></p>
> The core lightweight HTTP client for Node
[GitHub](https://github.com/ethanent/centra) | [NPM](https://npmjs.com/package/centra)
## Install
```shell
npm i centra
```
## Why centra?
centra is the best request library for developers; it provides a number of extremely useful features while still being one of the most lightweight Node.js HTTP client libraries available.
## Use centra!
First, require the library.
```js
const c = require('centra')
```
Then let's make a request in an async function!
```js
;(async () => {
const res = await c('https://example.com').send()
console.log(await res.text())
})()
```
## More advanced usage
### Send data in a JSON body
```js
c('https://example.com/nonexistentJSONAPI', 'POST').body({
'name': 'Ethan'
}, 'json').send().then((res) => {
/*...*/
})
```
### Send data in a form body
```js
c('https://example.com/nonexistentJSONAPI', 'POST').body({
'name': 'Ethan'
}, 'form').send().then((res) => {
/*...*/
})
```
### Set query string parameters
One at a time:
```js
c('https://example.com/user').query('id', 'u1817760').send().then((res) => {
/*...*/
})
```
Many at a time:
```js
c('https://example.com/user').query({
'id', 'u1817760',
'name': 'Ethan'
}).send().then((res) => {
/*...*/
})
```
### Set a request timeout
```js
c('https://example.com').timeout(2000).send().then((res) => {
// Success!
}).catch((err) => {
// Has the request timed out?
})
```
### Stream a request's response
In this example, the [stream](https://nodejs.org/api/stream.html) is piped to a file:
```js
// require the fs module beforehand
c('https://example.com').stream().send().then((stream) => stream.pipe(fs.createWriteStream(path.join(__dirname, 'logo.png'))))
```
### Follow redirects
```js
c('https://example.com/').followRedirects(5).send()
```
### Switch paths on the fly
```js
c('https://example.com/test').path('/hello').send()
// This will make a request to https://example.com/test/hello
```
### Specify request headers
One at a time:
```js
c('https://example.com').header('Content-Type', 'application/json').send()
```
Many at a time:
```js
c('https://example.com').header({
'Content-Type': 'application/json',
'X-Connecting-With': 'centra'
}).send()
```
### Modify core HTTP request options
See [http.request](https://nodejs.org/dist/latest-v10.x/docs/api/http.html#http_http_request_url_options_callback)'s options for more information about core HTTP request options.
Let's change our localAddress as an example.
```js
c('https://example.com').option('localAddress', '127.0.0.2').send()
```
### Accept compressed responses
```js
c('https://example.com').compress().send()
// This will cause centra to accept compressed content from the server. (gzip and deflate are currently supported)
```
|