3.0.1 • Published 24 days ago
httpx v3.0.1
httpx
http(s) module with power.
Installation
npm install httpx --save
Usage
import * as httpx from 'httpx';
Request URL
const response = await httpx.request('http://www.baidu.com/');
const body = await httpx.read(response, 'utf-8');
console.log(body);
Request SSE URL
const response = await httpx.request('sse url');
for await (const event of httpx.readAsSSE(response)) {
console.log(event);
}
API
httpx.request(url[, options])
It returns Promise<Response>
.
Requests the url with options, then return the response.
- url String | Object - The URL to request, either a String or a Object that return by url.parse.
- options Object - Optional
- method String - Request method, defaults to
GET
. Could beGET
,POST
,DELETE
orPUT
. - data String | Buffer | Readable - Manually set the content of payload.
- headers Object - Request headers.
- timeout Number - Request timeout in milliseconds. Defaults to 3000. When timeout happen, will return
RequestTimeout
. - agent http.Agent - HTTP/HTTPS Agent object.
Set
false
if you does not use agent. - beforeRequest Function - Before request hook, you can change every thing here.
- compression Boolean - Enable compression support. Tell server side responses compressed data
- method String - Request method, defaults to
httpx.read(response[, encoding])
It returns Promise<Buffer | String>
.
Consume the response and read all data from the response.
- response Response - the Client response. Don't setEncoding() for the response.
- encoding String - Optional. If specify the encoding, will return String. If not specify encoding, return the buffer.
httpx.readAsSSE(response)
It returns AsyncGenerator<Event, void, unknown>
.
Consume the response data with async iterator.
- response Response - the Client response. Don't setEncoding() for the response.
Using with http proxy
import { SocksProxyAgent } from 'socks-proxy-agent';
import * as httpx from 'httpx';
await httpx.request('http://www.baidu.com/', {
// pass a http proxy agent
agent: new SocksProxyAgent('socks://your_proxy_server:3001')
});
License
The MIT license
3.0.1
24 days ago
3.0.0
24 days ago
2.3.2
2 months ago
2.3.1
5 months ago
2.3.0
7 months ago
2.2.7
3 years ago
2.2.6
4 years ago
2.2.5
4 years ago
2.2.4
4 years ago
2.2.3
4 years ago
2.2.2
4 years ago
2.2.1
4 years ago
2.2.0
5 years ago
2.1.4
6 years ago
2.1.3
6 years ago
2.1.2
7 years ago
2.1.1
7 years ago
2.1.0
7 years ago
2.0.0
8 years ago
1.0.0
9 years ago
0.1.0
10 years ago
0.0.6
10 years ago
0.0.5
10 years ago
0.0.4
11 years ago
0.0.3
11 years ago
0.0.2
11 years ago
0.0.1
11 years ago
0.0.0
11 years ago