https://github.com/digitalbazaar/http-client
An opinionated, isomorphic HTTP client.
https://github.com/digitalbazaar/http-client
Last synced: about 1 year ago
JSON representation
An opinionated, isomorphic HTTP client.
- Host: GitHub
- URL: https://github.com/digitalbazaar/http-client
- Owner: digitalbazaar
- License: bsd-3-clause
- Created: 2020-06-10T14:24:12.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-26T01:03:23.000Z (over 1 year ago)
- Last Synced: 2025-03-26T01:36:09.494Z (over 1 year ago)
- Language: JavaScript
- Size: 96.7 KB
- Stars: 2
- Watchers: 12
- Forks: 7
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# http-client
An opinionated, isomorphic HTTP client for Node.js, browsers, and React Native.
### Usage
#### Import httpClient (Node.js)
```js
import https from 'https';
import {httpClient} from '@digitalbazaar/http-client';
```
#### Import httpClient (browsers or React Native)
```js
import {httpClient} from '@digitalbazaar/http-client';
```
#### Import and initialize a custom Bearer Token client
```js
import {httpClient} from '@digitalbazaar/http-client';
const httpsAgent = new https.Agent({rejectUnauthorized: false});
const accessToken = '12345';
const headers = {Authorization: `Bearer ${accessToken}`};
const client = httpClient.extend({headers, httpsAgent});
// subsequent http calls will include an 'Authorization: Bearer 12345' header,
// and use the provided httpsAgent
```
#### GET a JSON response in the browser
```js
try {
const response = await httpClient.get('http://httpbin.org/json');
return response.data;
} catch(e) {
// status is HTTP status code
// data is JSON error from the server
const {data, status} = e;
throw e;
}
```
#### GET a JSON response in Node with an HTTP Agent
```js
import https from 'https';
// use an agent to avoid self-signed certificate errors
const agent = new https.Agent({rejectUnauthorized: false});
try {
const response = await httpClient.get('http://httpbin.org/json', {agent});
return response.data;
} catch(e) {
// status is HTTP status code
// data is JSON error from the server if available
const {data, status} = e;
throw e;
}
```
#### GET HTML by overriding default headers
```js
const headers = {Accept: 'text/html'};
try {
const response = await httpClient.get('http://httpbin.org/html', {headers});
// see: https://developer.mozilla.org/en-US/docs/Web/API/Response#methods
return response.text();
} catch(e) {
// status is HTTP status code
// any message from the server can be parsed from the response if present
const {response, status} = e;
throw e;
}
```
#### POST a JSON payload
```js
try {
const response = await httpClient.post('http://httpbin.org/json', {
// `json` is the payload or body of the POST request
json: {some: 'data'}
});
return response.data;
} catch(e) {
// status is HTTP status code
// data is JSON error from the server
const {data, status} = e;
throw e;
}
```
#### POST a JSON payload in Node with an HTTP Agent
```js
import https from 'https';
// use an agent to avoid self-signed certificate errors
const agent = new https.Agent({rejectUnauthorized: false});
try {
const response = await httpClient.post('http://httpbin.org/json', {
agent,
// `json` is the payload or body of the POST request
json: {some: 'data'}
});
return response.data;
} catch(e) {
// status is HTTP status code
// data is JSON error from the server
const {data, status} = e;
throw e;
}
```