DolphinScheduler/escheduler-ui/dist/lib/@fedor/io/README.md

# io

Promise based HTTP client for the browser and node.js wrapper axios and add jsonp support

## Installing

Using npm:

```bash
$ npm install @fedor/io
```

## Test
```bash
//test in browser with karma
$ npm run test
//test in node with mocha
$ npm run node-test
```

## Build
```bash
$ npm run build
```

## Example

Performing a request

```js
io[method](url,data,success,fail,config)
io.get(
  // request url
  '/user',
  // optional request query data or request data
  {ID: 12345},
  //handle business success
  function (data) {
    console.log(data);
  },
  //handle business fail when code is not false value or server error
  function (error) {
    console.log(error)
  },
  //extra config  or axios config
  {
    // use application/json with modern api
    emulateJSON:false
  })
  //handle success in promise
  .then(function (data) {
    console.log(data);
  })
  //handle error in promise
  .catch(function (error) {
    console.log(error);
    //error.$ is origin error throw by axios
    console.log(error.$);
  });
```
## response
response data is formatted as
```js
{
  code:0,
  data:"data from server"
  message:"message from server"
}
```
response error is formatted as
```js
{
  code:"error code",
  data:"error data from server",
  message:"error message from server",
  $:axios throw error
}
```

## config
see <https://github.com/mzabriskie/axios#request-config>
```js
{
    // use application/json with modern api
    emulateJSON:false
}
```

## axios

```
//the axios instance is in io.fetch and origin axios is in io.axios
//if you want to use interceptors
// request interceptor
io.interceptors.request.use(function (config) {
    // Do something before request is sent
    return config;
  }, function (error) {
    // Do something with request error
    return Promise.reject(error);
  });

// response interceptor
io.interceptors.response.use(function (response) {
    // Do something with response data
    return response;
  }, function (error) {
    // Do something with response error
    return Promise.reject(error);
  });

```
## instance
create instance with config
```js
const instance = io.create({
  baseURL:"http://www.analysys.cn",
  emulateJSON:false
})
```
## defaults
set default config in all instance
```js
io.config.emulateJSON = false
```

for more detail see <http://git.analysys.cn/npm/io/tree/master/test>