Skip to content

Latest commit

 

History

History
154 lines (122 loc) · 6.38 KB

axios.md

File metadata and controls

154 lines (122 loc) · 6.38 KB

模板版本：v0.2.2

axios

License

[!TIP] Github 地址

安装与使用

npm

npm install [email protected]

bower

bower install [email protected]

yarn

yarn add [email protected]

Once the package is installed, you can import the library using import or require approach:

import axios, { isCancel, AxiosError } from "axios";

You can also use the default export, since the named export is just a re-export from the Axios factory:

import axios from "axios";

console.log(axios.isCancel("something"));

下面的代码展示了这个库的基本使用场景：

[!WARNING] 使用时 import 的库名不变。

import axios from "axios";
//const axios = require('axios'); // legacy way

// Make a request for a user with a given ID
axios
  .get("/user?ID=12345")
  .then(function (response) {
    // handle success
    console.log(response);
  })
  .catch(function (error) {
    // handle error
    console.log(error);
  })
  .finally(function () {
    // always executed
  });

// Optionally the request above could also be done as
axios
  .get("/user", {
    params: {
      ID: 12345,
    },
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  })
  .finally(function () {
    // always executed
  });

// Want to use async/await? Add the `async` keyword to your outer function/method.
async function getUser() {
  try {
    const response = await axios.get("/user?ID=12345");
    console.log(response);
  } catch (error) {
    console.error(error);
  }
}

约束与限制

兼容性

本文档内容基于以下版本验证通过：

  1. RNOH：0.72.20; SDK：HarmonyOS NEXT Developer Preview2; IDE：DevEco Studio 5.0.3.200; ROM：205.0.0.18;
  2. RNOH：0.72.33; SDK：OpenHarmony 5.0.0.71(API Version 12 Release); IDE：DevEco Studio 5.0.3.900; ROM：NEXT.0.0.71;

API

[!TIP] "Platform"列表示该属性在原三方库上支持的平台。

[!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。

Name Description Type Required HarmonyOS Support
axios.request(config) 别名发送request请求 function / yes
axios.get(url[, config]) 别名发送get请求 function / yes
axios.delete(url[, config]) 别名发送delete请求 function / yes
axios.head(url[, config]) 别名发送head请求 function / yes
axios.options(url[, config]) 别名发送options请求 function / yes
axios.post(url[, data[, config]]) 别名发送post请求 function / yes
axios.put(url[, data[, config]]) 别名发送put请求 function / yes
axios.patch(url[, data[, config]]) 别名发送patch请求 function / yes
axios#request(config) 实例发送request请求 function / yes
axios#get(url[, config]) 实例发送get请求 function / yes
axios#delete(url[, config]) 实例发送delete请求 function / yes
axios#head(url[, config]) 实例发送head请求 function / yes
axios#options(url[, config]) 实例发送options请求 function / yes
axios#post(url[, data[, config]]) 实例发送post请求 function / yes
axios#put(url[, data[, config]]) 实例发送put请求 function / yes
axios#patch(url[, data[, config]]) 实例发送patch请求 function / yes
url 配置中请求的地址 function / yes
method 配置中请求时使用的方法 function / yes
baseURL 配置中自动加在url地址前 function / yes
headers 配置中自定义请求头 function / yes
params 配置中请求一起发送时的参数 function / yes
data 配置中请求体发送的数据 function / yes
timeout 配置中请求超时的毫秒数 function / yes
proxy 配置中设置代理 function / yes
Response Schema 响应类型 function / yes
Config Defaults 默认配置 function / yes
requestInterceptors 请求拦截器 function / yes
responseInterceptors 响应拦截器 function / yes
Handling Errors 错误处理 function / yes
AbortController 中止控制器 function / yes
CancelToken 取消令牌 function / yes

其他

开源协议

本项目基于 The MIT License (MIT) ，请自由地享受和参与开源。