Compare commits

...

33 Commits

Author SHA1 Message Date
AJ ONeal bb30d5acf6
1.8.2 2022-06-14 01:37:28 -06:00
AJ ONeal 5b539deb7b
fix: copy http options from opts (not opts.uri) 2022-06-14 01:24:50 -06:00
AJ ONeal 0a2e7afa76
1.8.1 2022-01-12 12:45:07 -07:00
AJ ONeal ba60df7eab
fix: don't JSON.stringify a string body, duh 2022-01-12 12:42:34 -07:00
AJ ONeal bc4f6e59c0 1.8.0 2021-10-18 01:42:07 -06:00
AJ ONeal 3842ee1d61 docs: add CHANGELOG.md 2021-10-18 01:41:08 -06:00
AJ ONeal 9518cb970b feature: add resp.stream.body() and resp.ok 2021-10-18 01:38:44 -06:00
AJ ONeal 2e9a643c0f feature: fail faster on bad createWriteStream 2021-10-18 00:55:04 -06:00
AJ ONeal dcd41a33d0 chore: add linter config 2021-10-18 00:47:39 -06:00
AJ ONeal 5f5e0b6066 bugfix: return after error callback 2021-10-18 00:47:06 -06:00
AJ ONeal ed2bab931f
Update README.md 2021-08-20 22:57:43 -06:00
AJ ONeal a95d003ed5
docs: link to form-data v2.x (JavaScript) docs 2021-08-06 15:27:06 -06:00
AJ ONeal 5149bc9dcb
docs: clarify stream usage 2021-08-06 14:07:03 -06:00
AJ ONeal 95a12a8285 v1.7.0 add stream support 2021-01-14 16:35:07 -07:00
AJ ONeal 9395ec96e3 make Prettier (v2) 2021-01-14 16:07:48 -07:00
AJ ONeal 3574e35635 v1.6.1: userAgent and docs 2020-04-28 23:14:50 -06:00
AJ ONeal 508f1ce591 add comments 2020-04-28 23:00:26 -06:00
AJ ONeal c2c4b5b2de v1.6.0: add default User-Agent, bugfixes 2020-04-28 22:58:11 -06:00
AJ ONeal f6557b7610 handle possible readable body error 2020-04-28 22:56:12 -06:00
AJ ONeal 4b9a1f07ee add default User-Agent 2020-04-28 22:43:27 -06:00
AJ ONeal e22baa8eae v1.5.0: add pipe support, fix bearer bug 2020-03-12 02:01:23 -06:00
AJ ONeal 812f4e6062 bugfix request compat opts.auth.bearer 2020-03-12 01:59:33 -06:00
AJ ONeal 5b5cd36aa5 allow pipe-able inputs 2020-03-12 01:57:10 -06:00
AJ ONeal 4f3fe38ee4 update docs for promises 2020-02-27 02:17:07 +00:00
AJ ONeal ef3183e984 add 80/20 message 2020-02-20 17:34:27 +00:00
AJ ONeal e384aead9b v1.4.2: regression fix: copy 'method' to final object 2019-11-01 01:19:47 -06:00
AJ ONeal 87bf5a5fc5 v1.4.2: regression fix: copy 'method' to final object 2019-11-01 01:18:25 -06:00
AJ ONeal 1692b9e7df v1.4.1: GET by default *after* POST body check 2019-10-29 21:53:39 -06:00
AJ ONeal 8f5133385b v1.4.0: add promise support and easy debugging 2019-10-29 14:57:28 -06:00
AJ ONeal 1507b38503 v1.3.12: bugfix json request 2019-10-29 14:42:26 -06:00
AJ ONeal 9ab91d9721 make Prettier 2019-10-29 14:31:30 -06:00
AJ ONeal b6900b937b remove extraneous variable 2019-06-04 04:20:29 +00:00
AJ ONeal be91c1b78f show promise usage 2019-06-04 04:19:11 +00:00
19 changed files with 1125 additions and 562 deletions

22
.jshintrc Normal file
View File

@ -0,0 +1,22 @@
{
"browser": true,
"node": true,
"esversion": 11,
"curly": true,
"sub": true,
"bitwise": true,
"eqeqeq": true,
"forin": true,
"freeze": true,
"immed": true,
"latedef": "nofunc",
"nonbsp": true,
"nonew": true,
"plusplus": true,
"undef": true,
"unused": "vars",
"strict": true,
"maxdepth": 3,
"maxstatements": 100,
"maxcomplexity": 40
}

8
.prettierrc Normal file
View File

@ -0,0 +1,8 @@
{
"bracketSpacing": true,
"printWidth": 80,
"singleQuote": true,
"tabWidth": 4,
"trailingComma": "none",
"useTabs": false
}

6
CHANGELOG.md Normal file
View File

@ -0,0 +1,6 @@
# CHANGELOG
## v1.8.0
- add `resp.ok` - same as WHATWG fetch `resp.ok = (resp.statusCode >= 200 && resp.statusCode < 300)`
- add `resp.stream.body()` to populate `resp.body` rather than (or perhaps in addition to) continuing to stream (useful for error handling)

65
EXTRA.md Normal file
View File

@ -0,0 +1,65 @@
# Extra
There are some niche features of @root/request which are beyond the request.js
compatibility.
## async/await & Promises
The differences in async support are explained in [README.md](/README.md), up near the top.
If you're familiar with Promises (and async/await), then it's pretty self-explanatory.
## ok
Just like WHATWG `fetch`, we have `resp.ok`:
```js
let resp = await request({
url: 'https://example.com'
}).then(mustOk);
```
```js
function mustOk(resp) {
if (!resp.ok) {
// handle error
throw new Error('BAD RESPONSE');
}
return resp;
}
```
## streams
The differences in stream support are explained in [README.md](/README.md), up near the top.
## userAgent
There's a default User-Agent string describing the version of @root/request, node.js, and the OS.
Add to the default User-Agent
```js
request({
// ...
userAgent: 'my-package/1.0' // add to agent
});
```
Replace the default User-Agent
```js
request({
// ...
headers: { 'User-Agent': 'replace/0.0' }
});
```
Disable the default User-Agent:
```js
request({
// ...
headers: { 'User-Agent': false }
});
```

303
README.md
View File

@ -1,39 +1,147 @@
# [µRequest](https://git.rootprojects.org/root/request.js) | a [Root](https://rootprojects.org) project
# [@root/request](https://git.rootprojects.org/root/request.js) | a [Root](https://rootprojects.org) project
> Minimalist HTTP client
A lightweight alternative to (and drop-in replacement for) request.
A lightweight alternative to (and 80/20 drop-in replacement for) request.
Has the 20% of features that 80%+ of people need, in about 500 LoC.
Written from scratch, with zero-dependencies.
## Super simple to use
µRequest is designed to be a drop-in replacement for request. It supports HTTPS and follows redirects by default.
@root/request is designed to be a drop-in replacement for request. It also supports Promises and async/await by default, enhanced stream support, and a few other things as mentioned below.
```bash
npm install --save @root/request
# or npm install git+ssh://git@git.therootcompany.com/request.js
```
```js
var request = require('@root/request');
request('http://www.google.com', function (error, response, body) {
console.log('error:', error); // Print the error if one occurred
console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
console.log('body:', body); // Print the HTML for the Google homepage.
console.log('error:', error); // Print the error if one occurred
console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
console.log('body:', body); // Print the HTML for the Google homepage.
});
```
**Using Promises**
```js
var request = require('@root/request');
request('http://www.google.com')
.then(function (response) {
console.log('statusCode:', response.statusCode); // Print the response status code if a response was received
console.log('body:', response.body); // Print the HTML for the Google homepage.
})
.catch(function (error) {
console.log('error:', error); // Print the error if one occurred
});
```
**Streaming**
In order to keep this library lightweight, performant, and keep the code easy to
read, the streaming behavior is **_slightly different_** from that of
`request.js`.
```diff
-var request = require('request');
+var request = require('@root/request');
-var stream = request({ url, headers });
+var stream = await request({ url, headers });
let attachment = await new MailgunAPI.Attachment({
data: stream
})
```
Example:
```js
var request = require('@root/request');
var resp = await request({
url: 'http://www.google.com',
stream: true // true | 'filename.ext' | stream.Writable
});
// 'resp' itself is a ReadableStream
resp.on('data', function () {
// got some data
});
resp.on('end', function () {
// the data has ended
});
// 'resp.stream' is a Promise that is resolved when the read stream is destroyed
await resp.stream; // returns `undefined`
console.log('Done');
```
The difference is that we don't add an extra layer of stream abstraction.
You must use the response from await, a Promise, or the callback.
You can also give a file path:
```js
request({
url: 'http://www.google.com',
stream: '/tmp/google-index.html'
});
```
Which is equivalent to passing a write stream for the file:
```js
request({
url: 'http://www.google.com',
stream: fs.createWriteStream('/tmp/google-index.html')
});
```
Also, `await resp.stream.body()` can be used to get back the full body (the same as if you didn't use the `stream` option:
```js
let resp = await request({
url: 'http://www.google.com',
stream: true
});
if (!resp.ok) {
await resp.stream.body();
console.error(resp.body);
}
```
## Table of contents
- [Forms](#forms)
- [HTTP Authentication](#http-authentication)
- [Custom HTTP Headers](#custom-http-headers)
- [Unix Domain Sockets](#unix-domain-sockets)
- [**All Available Options**](#requestoptions-callback)
- [Extra Features](/EXTRA.md)
- [Forms](#forms)
- [HTTP Authentication](#http-authentication)
- [Custom HTTP Headers](#custom-http-headers)
- [Unix Domain Sockets](#unix-domain-sockets)
- [**All Available Options**](#requestoptions-callback)
## Extra Features
The following are features that the original `request` did not have, but have been added for convenience in `@root/request`.
- Support for `async`/`await` & `Promise`s (as explained above)
- `request({ userAgent: 'my-api/1.1' })` (for building API clients)
- `resp.ok` (just like `fetch`)
- `resp.stream` (see above)
See [EXTRA.md](/EXTRA.md)
## Forms
`urequest` supports `application/x-www-form-urlencoded` and `multipart/form-data` form uploads.
`@root/request` supports `application/x-www-form-urlencoded` and `multipart/form-data` form uploads.
<!-- For `multipart/related` refer to the `multipart` API. -->
#### application/x-www-form-urlencoded (URL-Encoded Forms)
@ -41,57 +149,66 @@ request('http://www.google.com', function (error, response, body) {
URL-encoded forms are simple.
```js
request.post('http://service.com/upload', {form:{key:'value'}})
request.post('http://service.com/upload', { form: { key: 'value' } });
// or
request.post({url:'http://service.com/upload', form: {key:'value'}}, function(err,httpResponse,body){ /* ... */ })
request.post(
{ url: 'http://service.com/upload', form: { key: 'value' } },
function (err, httpResponse, body) {
/* ... */
}
);
```
<!--
// or
request.post('http://service.com/upload').form({key:'value'})
-->
#### multipart/form-data (Multipart Form Uploads)
For `multipart/form-data` we use the [form-data](https://github.com/form-data/form-data) library by [@felixge](https://github.com/felixge). For the most cases, you can pass your upload form data via the `formData` option.
For `multipart/form-data` we use the [form-data](https://github.com/form-data/form-data/tree/v2.5.1) library by [@felixge](https://github.com/felixge). For the most cases, you can pass your upload form data via the `formData` option.
To use `form-data`, you must install it separately:
```bash
npm install --save form-data@2
npm install --save form-data@2.x
```
```js
var formData = {
// Pass a simple key-value pair
my_field: 'my_value',
// Pass data via Buffers
my_buffer: Buffer.from([1, 2, 3]),
// Pass data via Streams
my_file: fs.createReadStream(__dirname + '/unicycle.jpg'),
// Pass multiple values /w an Array
attachments: [
fs.createReadStream(__dirname + '/attachment1.jpg'),
fs.createReadStream(__dirname + '/attachment2.jpg')
],
// Pass optional meta-data with an 'options' object with style: {value: DATA, options: OPTIONS}
// Use case: for some types of streams, you'll need to provide "file"-related information manually.
// See the `form-data` README for more information about options: https://github.com/form-data/form-data
custom_file: {
value: fs.createReadStream('/dev/urandom'),
options: {
filename: 'topsecret.jpg',
contentType: 'image/jpeg'
// Pass a simple key-value pair
my_field: 'my_value',
// Pass data via Buffers
my_buffer: Buffer.from([1, 2, 3]),
// Pass data via Streams
my_file: fs.createReadStream(__dirname + '/unicycle.jpg'),
// Pass multiple values /w an Array
attachments: [
fs.createReadStream(__dirname + '/attachment1.jpg'),
fs.createReadStream(__dirname + '/attachment2.jpg')
],
// Pass optional meta-data with an 'options' object with style: {value: DATA, options: OPTIONS}
// Use case: for some types of streams, you'll need to provide "file"-related information manually.
// See the `form-data` README for more information about options: https://github.com/form-data/form-data
custom_file: {
value: fs.createReadStream('/dev/urandom'),
options: {
filename: 'topsecret.jpg',
contentType: 'image/jpeg'
}
}
}
};
request.post({url:'http://service.com/upload', formData: formData}, function optionalCallback(err, httpResponse, body) {
if (err) {
return console.error('upload failed:', err);
}
console.log('Upload successful! Server responded with:', body);
});
request.post(
{ url: 'http://service.com/upload', formData: formData },
function optionalCallback(err, httpResponse, body) {
if (err) {
return console.error('upload failed:', err);
}
console.log('Upload successful! Server responded with:', body);
}
);
```
<!--
For advanced cases, you can access the form-data object itself via `r.form()`. This can be modified until the request is fired on the next cycle of the event-loop. (Note that this calling `form()` will clear the currently set form data for that request.)
@ -118,27 +235,28 @@ request.get('http://some.server.com/').auth('username', 'password', false);
request.get('http://some.server.com/').auth(null, null, true, 'bearerToken');
// or
-->
```js
request.get('http://some.server.com/', {
'auth': {
'user': 'username',
'pass': 'password',
'sendImmediately': false
}
auth: {
user: 'username',
pass: 'password',
sendImmediately: false
}
});
// or
request.get('http://some.server.com/', {
'auth': {
'bearer': 'bearerToken'
}
auth: {
bearer: 'bearerToken'
}
});
```
If passed as an option, `auth` should be a hash containing values:
- `user` || `username`
- `pass` || `password`
- `bearer` (optional)
- `user` || `username`
- `pass` || `password`
- `bearer` (optional)
<!--
- `sendImmediately` (optional)
@ -162,8 +280,8 @@ var username = 'username',
password = 'password',
url = 'http://' + username + ':' + password + '@some.server.com';
request({url: url}, function (error, response, body) {
// Do more stuff with 'body' here
request({ url: url }, function (error, response, body) {
// Do more stuff with 'body' here
});
```
@ -194,18 +312,18 @@ custom `User-Agent` header as well as https.
var request = require('request');
var options = {
url: 'https://api.github.com/repos/request/request',
headers: {
'User-Agent': 'request'
}
url: 'https://api.github.com/repos/request/request',
headers: {
'User-Agent': 'request'
}
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
var info = JSON.parse(body);
console.log(info.stargazers_count + " Stars");
console.log(info.forks_count + " Forks");
}
if (!error && response.statusCode == 200) {
var info = JSON.parse(body);
console.log(info.stargazers_count + ' Stars');
console.log(info.forks_count + ' Forks');
}
}
request(options, callback);
@ -217,11 +335,13 @@ request(options, callback);
## UNIX Domain Sockets
`urequest` supports making requests to [UNIX Domain Sockets](https://en.wikipedia.org/wiki/Unix_domain_socket). To make one, use the following URL scheme:
`@root/request` supports making requests to [UNIX Domain Sockets](https://en.wikipedia.org/wiki/Unix_domain_socket). To make one, use the following URL scheme:
```js
/* Pattern */ 'http://unix:SOCKET:PATH'
/* Example */ request.get('http://unix:/absolute/path/to/unix.socket:/request/path')
/* Pattern */ 'http://unix:SOCKET:PATH';
/* Example */ request.get(
'http://unix:/absolute/path/to/unix.socket:/request/path'
);
```
Note: The `SOCKET` path is assumed to be absolute to the root of the host file system.
@ -234,9 +354,9 @@ Note: The `SOCKET` path is assumed to be absolute to the root of the host file s
The first argument can be either a `url` or an `options` object. The only required option is `uri`; all others are optional.
- `uri` || `url` - fully qualified uri or a parsed url object from `url.parse()`
- `method` - http method (default: `"GET"`)
- `headers` - http headers (default: `{}`)
- `uri` || `url` - fully qualified uri or a parsed url object from `url.parse()`
- `method` - http method (default: `"GET"`)
- `headers` - http headers (default: `{}`)
<!-- TODO
- `baseUrl` - fully qualified uri string used as the base url. Most useful with `request.defaults`, for example when you want to do many requests to the same domain. If `baseUrl` is `https://example.com/api/`, then requesting `/end/point?test=true` will fetch `https://example.com/api/end/point?test=true`. When `baseUrl` is given, `uri` must also be a string.
@ -244,8 +364,8 @@ The first argument can be either a `url` or an `options` object. The only requir
---
- `body` - entity body for PATCH, POST and PUT requests. Must be a `Buffer`, `String` or `ReadStream`. If `json` is `true`, then `body` must be a JSON-serializable object.
- `json` - sets `body` to JSON representation of value and adds `Content-type: application/json` header. Additionally, parses the response body as JSON.
- `body` - entity body for PATCH, POST and PUT requests. Must be a `Buffer`, `String` or `ReadStream`. If `json` is `true`, then `body` must be a JSON-serializable object.
- `json` - sets `body` to JSON representation of value and adds `Content-type: application/json` header. Additionally, parses the response body as JSON.
<!-- TODO
- `form` - when passed an object or a querystring, this sets `body` to a querystring representation of value, and adds `Content-type: application/x-www-form-urlencoded` header. When passed no options, a `FormData` instance is returned (and is piped to request). See "Forms" section above.
@ -266,15 +386,15 @@ The first argument can be either a `url` or an `options` object. The only requir
---
- `followRedirect` - follow HTTP 3xx responses as redirects (default: `true`). This property can also be implemented as function which gets `response` object as a single argument and should return `true` if redirects should continue or `false` otherwise.
- `followAllRedirects` - follow non-GET HTTP 3xx responses as redirects (default: `false`)
- `followOriginalHttpMethod` - by default we redirect to HTTP method GET. you can enable this property to redirect to the original HTTP method (default: `false`)
- `maxRedirects` - the maximum number of redirects to follow (default: `10`)
- `removeRefererHeader` - removes the referer header when a redirect happens (default: `false`). **Note:** if true, referer header set in the initial request is preserved during redirect chain.
- `followRedirect` - follow HTTP 3xx responses as redirects (default: `true`). This property can also be implemented as function which gets `response` object as a single argument and should return `true` if redirects should continue or `false` otherwise.
- `followAllRedirects` - follow non-GET HTTP 3xx responses as redirects (default: `false`)
- `followOriginalHttpMethod` - by default we redirect to HTTP method GET. you can enable this property to redirect to the original HTTP method (default: `false`)
- `maxRedirects` - the maximum number of redirects to follow (default: `10`)
- `removeRefererHeader` - removes the referer header when a redirect happens (default: `false`). **Note:** if true, referer header set in the initial request is preserved during redirect chain.
---
- `encoding` - encoding to be used on `setEncoding` of response data. If `null`, the `body` is returned as a `Buffer`. Anything else **(including the default value of `undefined`)** will be passed as the [encoding](http://nodejs.org/api/buffer.html#buffer_buffer) parameter to `toString()` (meaning this is effectively `utf8` by default). (**Note:** if you expect binary data, you should set `encoding: null`.)
- `encoding` - encoding to be used on `setEncoding` of response data. If `null`, the `body` is returned as a `Buffer`. Anything else **(including the default value of `undefined`)** will be passed as the [encoding](http://nodejs.org/api/buffer.html#buffer_buffer) parameter to `toString()` (meaning this is effectively `utf8` by default). (**Note:** if you expect binary data, you should set `encoding: null`.)
<!-- TODO
- `gzip` - if `true`, add an `Accept-Encoding` header to request compressed content encodings from the server (if not already present) and decode supported content encodings in the response. **Note:** Automatic decoding of the response content is performed on the body data returned through `request` (both through the `request` stream and passed to the callback function) but is not performed on the `response` stream (available from the `response` event) which is the unmodified `http.IncomingMessage` object which may contain compressed data. See example below.
@ -299,30 +419,31 @@ instead, it **returns a wrapper** that has your default settings applied to it.
`request.defaults` to add/override defaults that were previously defaulted.
For example:
```js
//requests using baseRequest() will set the 'x-token' header
var baseRequest = request.defaults({
headers: {'x-token': 'my-token'}
})
headers: { 'x-token': 'my-token' }
});
//requests using specialRequest() will include the 'x-token' header set in
//baseRequest and will also include the 'special' header
var specialRequest = baseRequest.defaults({
headers: {special: 'special value'}
})
headers: { special: 'special value' }
});
```
### request.METHOD()
These HTTP method convenience functions act just like `request()` but with a default method already set for you:
- *request.get()*: Defaults to `method: "GET"`.
- *request.post()*: Defaults to `method: "POST"`.
- *request.put()*: Defaults to `method: "PUT"`.
- *request.patch()*: Defaults to `method: "PATCH"`.
- *request.del() / request.delete()*: Defaults to `method: "DELETE"`.
- *request.head()*: Defaults to `method: "HEAD"`.
- *request.options()*: Defaults to `method: "OPTIONS"`.
- _request.get()_: Defaults to `method: "GET"`.
- _request.post()_: Defaults to `method: "POST"`.
- _request.put()_: Defaults to `method: "PUT"`.
- _request.patch()_: Defaults to `method: "PATCH"`.
- _request.del() / request.delete()_: Defaults to `method: "DELETE"`.
- _request.head()_: Defaults to `method: "HEAD"`.
- _request.options()_: Defaults to `method: "OPTIONS"`.
---
@ -330,7 +451,7 @@ These HTTP method convenience functions act just like `request()` but with a def
There are at least <!--three--> two ways to debug the operation of `request`:
1. Launch the node process like `NODE_DEBUG=urequest node script.js`
1. Launch the node process like `NODE_DEBUG=@root/request node script.js`
(`lib,request,otherlib` works too).
2. Set `require('@root/request').debug = true` at any time (this does the same thing

View File

@ -5,12 +5,15 @@ var request = require('../');
// will redirect to https://www.github.com and then https://github.com
//request('http://www.github.com', function (error, response, body) {
request({ uri: { protocol: 'http:', hostname: 'www.github.com' } }, function (error, response, body) {
if (error) {
console.log('error:', error); // Print the error if one occurred
return;
}
console.log('statusCode:', response.statusCode); // The final statusCode
console.log('Final href:', response.request.uri.href); // The final URI
console.log('Body Length:', body.length); // body length
});
request(
{ uri: { protocol: 'http:', hostname: 'www.github.com' } },
function (error, response, body) {
if (error) {
console.log('error:', error); // Print the error if one occurred
return;
}
console.log('statusCode:', response.statusCode); // The final statusCode
console.log('Final href:', response.request.uri.href); // The final URI
console.log('Body Length:', body.length); // body length
}
);

View File

@ -8,21 +8,24 @@ var request = require('../');
// will redirect to https://www.github.com and then https://github.com
//request('http://www.github.com', function (error, response, body) {
request(
//{ url: 'http://postb.in/syfxxnko'
{ url: 'http://localhost:3007/form-data/'
, method: 'POST'
, headers: { 'X-Foo': 'Bar' }
, formData: {
foo: 'bar'
, baz: require('fs').createReadStream(require('path').join(__dirname, 'get-to-json.js'))
//{ url: 'http://postb.in/syfxxnko'
{
url: 'http://localhost:3007/form-data/',
method: 'POST',
headers: { 'X-Foo': 'Bar' },
formData: {
foo: 'bar',
baz: require('fs').createReadStream(
require('path').join(__dirname, 'get-to-json.js')
)
}
},
function (error, response, body) {
if (error) {
console.log('error:', error); // Print the error if one occurred
return;
}
console.log('statusCode:', response.statusCode); // The final statusCode
console.log('Body Length:', body.length); // body length
}
}
, function (error, response, body) {
if (error) {
console.log('error:', error); // Print the error if one occurred
return;
}
console.log('statusCode:', response.statusCode); // The final statusCode
console.log('Body Length:', body.length); // body length
}
);

View File

@ -3,10 +3,10 @@
//var request = require('urequest');
var request = require('../');
request('https://www.google.com', function (error, response, body) {
if (error) {
console.log('error:', error); // Print the error if one occurred
return;
}
console.log('response.toJSON()');
console.log(response.toJSON());
if (error) {
console.log('error:', error); // Print the error if one occurred
return;
}
console.log('response.toJSON()');
console.log(response.toJSON());
});

View File

@ -3,7 +3,7 @@
//var request = require('urequest');
var request = require('../');
request('http://www.google.com', function (error, response, body) {
console.log('error:', error); // Print the error if one occurred
console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
console.log('body:', body); // Print the HTML for the Google homepage.
console.log('error:', error); // Print the error if one occurred
console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
console.log('body:', body); // Print the HTML for the Google homepage.
});

View File

@ -3,7 +3,7 @@
//var request = require('urequest');
var request = require('../');
request('https://www.google.com', function (error, response, body) {
console.log('error:', error); // Print the error if one occurred
console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
console.log('body:', body); // Print the HTML for the Google homepage.
console.log('error:', error); // Print the error if one occurred
console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received
console.log('body:', body); // Print the HTML for the Google homepage.
});

View File

@ -4,13 +4,16 @@
var request = require('../');
// would normally redirect to https://www.github.com and then https://github.com
request({ uri: 'https://www.github.com', followRedirect: false }, function (error, response, body) {
if (error) {
console.log('error:', error); // Print the error if one occurred
return;
}
console.log('href:', response.request.uri.href); // The final URI
console.log('statusCode:', response.statusCode); // Should be 301 or 302
console.log('Location:', response.headers.location); // The redirect
console.log('Body:', body || JSON.stringify(body));
});
request(
{ uri: 'https://www.github.com', followRedirect: false },
function (error, response, body) {
if (error) {
console.log('error:', error); // Print the error if one occurred
return;
}
console.log('href:', response.request.uri.href); // The final URI
console.log('statusCode:', response.statusCode); // Should be 301 or 302
console.log('Location:', response.headers.location); // The redirect
console.log('Body:', body || JSON.stringify(body));
}
);

15
examples/postbin.js Normal file
View File

@ -0,0 +1,15 @@
'use strict';
var request = require('../');
request({
url: 'https://postb.in/1588134650162-6019286897499?hello=world'
//headers: { 'user-agent': false } // remove
//headers: { 'user-agent': 'test/1.0' } // overwrite
//userAgent: 'test/1.1' // add to the default
})
.then(function (resp) {
console.log(resp.body);
})
.catch(function (err) {
console.error(err);
});

View File

@ -0,0 +1,27 @@
'use strict';
var request = require('../');
async function main() {
var tpath = '/tmp/google-index.html';
var resp = await request({
url: 'https://google.com',
encoding: null,
stream: tpath
});
console.log('[Response Headers]');
console.log(resp.toJSON().headers);
//console.error(resp.headers, resp.body.byteLength);
await resp.stream;
console.log('[Response Body] written to', tpath);
}
main()
.then(function () {
console.log('Pass');
})
.catch(function (e) {
console.error('Fail');
console.error(e.stack);
});

34
examples/stream.js Normal file
View File

@ -0,0 +1,34 @@
'use strict';
var request = require('../');
async function main() {
var tpath = '/tmp/google-index.html';
var resp = await request({
url: 'https://google.com',
encoding: null,
stream: true
});
console.log('[Response Headers]');
console.log(resp.toJSON().headers);
resp.on('data', function (chunk) {
console.log('[Data]', chunk.byteLength);
});
resp.on('end', function (chunk) {
console.log('[End]');
});
//console.error(resp.headers, resp.body.byteLength);
await resp.stream;
console.log('[Close]');
}
main()
.then(function () {
console.log('Pass');
})
.catch(function (e) {
console.error('Fail');
console.error(e.stack);
});

View File

@ -8,18 +8,19 @@ var request = require('../');
// will redirect to https://www.github.com and then https://github.com
//request('http://www.github.com', function (error, response, body) {
request(
{ url: 'http://postb.in/2meyt50C'
, method: 'POST'
, headers: { 'X-Foo': 'Bar' }
, form: { foo: 'bar', baz: 'qux' }
}
, function (error, response, body) {
if (error) {
console.log('error:', error); // Print the error if one occurred
return;
{
url: 'http://postb.in/2meyt50C',
method: 'POST',
headers: { 'X-Foo': 'Bar' },
form: { foo: 'bar', baz: 'qux' }
},
function (error, response, body) {
if (error) {
console.log('error:', error); // Print the error if one occurred
return;
}
console.log('statusCode:', response.statusCode); // The final statusCode
console.log('Body Length:', body.length); // body length
console.log('Response:', response.toJSON()); // body length
}
console.log('statusCode:', response.statusCode); // The final statusCode
console.log('Body Length:', body.length); // body length
console.log('Response:', response.toJSON()); // body length
}
);

1006
index.js

File diff suppressed because it is too large Load Diff

5
package-lock.json generated Normal file
View File

@ -0,0 +1,5 @@
{
"name": "@root/request",
"version": "1.8.2",
"lockfileVersion": 1
}

View File

@ -1,29 +1,29 @@
{
"name": "@root/request",
"version": "1.3.11",
"description": "A lightweight, zero-dependency drop-in replacement for request",
"main": "index.js",
"files": [
"lib"
],
"directories": {
"example": "examples"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "https://git.rootprojects.org/root/request.js.git"
},
"keywords": [
"request",
"lightweight",
"alternative",
"http",
"https",
"call"
],
"author": "AJ ONeal <solderjs@gmail.com> (https://solderjs.com/)",
"license": "(MIT OR Apache-2.0)"
"name": "@root/request",
"version": "1.8.2",
"description": "A lightweight, zero-dependency drop-in replacement for request",
"main": "index.js",
"files": [
"lib"
],
"directories": {
"example": "examples"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "https://git.rootprojects.org/root/request.js.git"
},
"keywords": [
"request",
"lightweight",
"alternative",
"http",
"https",
"call"
],
"author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
"license": "(MIT OR Apache-2.0)"
}

View File

@ -2,10 +2,10 @@
var net = require('net');
var server = net.createServer(function (socket) {
socket.on('data', function (chunk) {
console.info(chunk.toString('utf8'));
});
})
server.listen(3007, function () {
console.info("Listening on", this.address());
socket.on('data', function (chunk) {
console.info(chunk.toString('utf8'));
});
});
server.listen(3007, function () {
console.info('Listening on', this.address());
});