Comparing version 1.2.4 to 1.2.5
## 16 April 2019 | ||
### [1.2.5](https://github.com/rqt/aqt/compare/v1.2.4...v1.2.5) | ||
- [doc] Use `http` namespace in types. | ||
### [1.2.4](https://github.com/rqt/aqt/compare/v1.2.3...v1.2.4) | ||
@@ -4,0 +8,0 @@ |
{ | ||
"name": "@rqt/aqt", | ||
"version": "1.2.4", | ||
"version": "1.2.5", | ||
"description": "An Advanced Network Request Package That Returns Body (Parsed As JSON If Needed), Headers And Status After Gzip Decompression.", | ||
@@ -5,0 +5,0 @@ "main": "build/index.js", |
@@ -40,16 +40,16 @@ # @rqt/aqt | ||
`import('http').OutgoingHttpHeaders` __<a name="type-outgoinghttpheaders">`OutgoingHttpHeaders`</a>__ | ||
`import('http').OutgoingHttpHeaders` __<a name="type-httpoutgoinghttpheaders">`http.OutgoingHttpHeaders`</a>__ | ||
__<a name="type-aqtoptions">`AqtOptions`</a>__: Configuration for requests. | ||
| Name | Type | Description | Default | | ||
| ----------- | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------- | | ||
| __data*__ | _Object_ | Optional data to send to the server with the request. | - | | ||
| type | _'form' \| 'json'_ | How to send data: `json` to serialise JSON data and `form` for url-encoded transmission with `json` mode by default. | `'json'` | | ||
| headers | _[OutgoingHttpHeaders](#type-outgoinghttpheaders)_ | Headers to use for the request. | - | | ||
| compress | _boolean_ | Add the `Accept-Encoding: gzip, deflate` header to indicate to the server that it can send a compressed response. | `true` | | ||
| timeout | _number_ | The timeout after which the request should fail. | - | | ||
| method | _string_ | What HTTP method to use in making of the request. When no method is given and `data` is present, defaults to `POST`. | - | | ||
| binary | _boolean_ | Whether to return a buffer instead of a string. | `false` | | ||
| justHeaders | _boolean_ | Whether to stop the request after response headers were received, without waiting for the data. | `false` | | ||
| Name | Type | Description | Default | | ||
| ----------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------- | | ||
| __data*__ | _Object_ | Optional data to send to the server with the request. | - | | ||
| type | _'form' \| 'json'_ | How to send data: `json` to serialise JSON data and `form` for url-encoded transmission with `json` mode by default. | `'json'` | | ||
| headers | _[http.OutgoingHttpHeaders](#type-httpoutgoinghttpheaders)_ | Headers to use for the request. | - | | ||
| compress | _boolean_ | Add the `Accept-Encoding: gzip, deflate` header to indicate to the server that it can send a compressed response. | `true` | | ||
| timeout | _number_ | The timeout after which the request should fail. | - | | ||
| method | _string_ | What HTTP method to use in making of the request. When no method is given and `data` is present, defaults to `POST`. | - | | ||
| binary | _boolean_ | Whether to return a buffer instead of a string. | `false` | | ||
| justHeaders | _boolean_ | Whether to stop the request after response headers were received, without waiting for the data. | `false` | | ||
```js | ||
@@ -69,3 +69,3 @@ import aqt from '@rqt/aqt' | ||
"content-type": "text/plain", | ||
"date": "Tue, 16 Apr 2019 14:12:33 GMT", | ||
"date": "Tue, 16 Apr 2019 14:36:31 GMT", | ||
"connection": "close", | ||
@@ -72,0 +72,0 @@ "transfer-encoding": "chunked" |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
29675