Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/forthedamn/net4j
Pluggable & Promise based HTTP client for the browser and node.js
https://github.com/forthedamn/net4j
axios http-client promise request typescript
Last synced: about 19 hours ago
JSON representation
Pluggable & Promise based HTTP client for the browser and node.js
- Host: GitHub
- URL: https://github.com/forthedamn/net4j
- Owner: forthedamn
- Created: 2019-03-05T06:13:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T17:18:41.000Z (almost 2 years ago)
- Last Synced: 2023-02-27T15:33:58.117Z (over 1 year ago)
- Topics: axios, http-client, promise, request, typescript
- Language: TypeScript
- Homepage:
- Size: 873 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# net4j
Pluggable & Promise based HTTP client for the browser and node.js
## Features
* Support Typescript
* Pluggable, easily unified processing
* Dependency injection
* Make XMLHttpRequests from the browser
* Make http requests from node.js
* Supports the Promise API
* Automatic transforms for JSON data
## Browser Support
 |  |  |  |  |  |
--- | --- | --- | --- | --- | --- |
Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 11 ✔ |
[](https://saucelabs.com/u/axios)
## Install
```bash
$ npm install net4j
$ yarn add net4j
```
## Example
### Normal Request
Performing a `GET` request
```ts
import Net from 'net4j';
const net = new Net();
// Type merge,so that /api/v2/goods will be typed
declare module 'net4j' {
interface IGetRoute {
'/api/v2/goods': {
request: {
id: number
}
response: {
data: {
GoodsInfo
}
}
},
}
}
// `GET` request
// result will be typed with {data: {GoodsInfo}}
const result = await net.get('/api/v2/goods');
```
### With plugins
```ts
import Net from 'net4j';
import { message, Modal } from 'antd';
import NetLog from 'net4j-log-plugin';
import NetSuccess, { SuccessConfig } from 'net4j-success-plugin';
import NetLoading, { LoadingConfig } from 'net4j-loading-plugin';
import NetException, { ExceptionConfig } from 'net4j-exception-plugin';
declare module 'net4j' {
// Merge plugin config to net4j config,then you can use it in every requst in net4j
interface Config extends SuccessConfig, LoadingConfig, ExceptionConfig {};
// Type merge,so that /api/v2/goods will be typed
interface IGetRoute {
'/api/v2/goods': {
request: {
id: number
}
response: {
data: {
GoodsInfo
}
}
},
}
}
// Exception code to message
// Exception code comes from http status,response result.code,promise reject error.code
const codeMsgMap = {
404: 'page not found',
403: function() {
// In this time, tipsComponent will not show.
redirect('/login');
},
5400: 'Name repeat'
}
const net = new Net(plugins: [
// Inject own log,so the exception and other operations will be reported
new NetLog({
log: {
info: myLogger.info,
error: myLogger.error,
},
}),
// When request is pending, message loading will display and close when request finish
new NetLoading({
loading: message.loading,
}),
// When request completed successfully, message.success will display
new NetSuccess({
tipsComponent: message.success,
}),
// When request get exception，error modal will display and error will be auto reported
new NetException({
tipsComponent: Modal.error,
codeMsgMap,
}),
]);
// `GET` request
// result will be typed with {data: {GoodsInfo}}
const result = await net.get('/api/v2/goods', {params: {id: 123}});
```
## Plugins
* [net4j-success-plugin](https://github.com/forthedamn/net4j/tree/master/packages/net4j-success-plugin): Unified set 「success tip」 when request completed successfully.
* [net4j-loading-plugin](https://github.com/forthedamn/net4j/tree/master/packages/net4j-loading-plugin): Unified set 「loading toast」 when request pending.
* [net4j-exception-plugin](https://github.com/forthedamn/net4j/tree/master/packages/net4j-exception-plugin): Unified set 「error tip」 when request get exception.
* [net4j-log-plugin](https://github.com/forthedamn/net4j/tree/master/packages/net4j-log-plugin): Inject 「log libary」 in request, it will be used when request get exception or other critical operations
### How to write a plugin
```ts
export interface Plugin {
beforeRequest?(e?: Error, config?: AxiosRequestConfig, lib?: ILib): Config | Promise;
// Inject libs to whole request, so other plugins use these libs
applyLib?(lib: { [key: string]: any}): { [key: string]: any};
afterRequest?(e?: Error, response?: T, lib?: ILib): T | Promise>;
}
```