request

title: Taro.request(option)

sidebar_label: request

Initiates an HTTPS request. Read related instructions before use.

Data Parameters

The data ultimately sent to the server must be a String. If the passed data is not a String, it will be converted to the String type according to the following rules:

• Data from the GET method is converted to a query string (encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...).

• Data from the POST method with header['content-type'] being application/json is serialized into the JSON format.

• Data from the POST method with header['content-type'] being application/x-www-form-urlencoded is converted to a query string (encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...)

Reference

Type

<T = any, U = any>(option: Option<U>) => RequestTask<T>

Parameters

Option

SuccessCallbackResult

dataType

Valid values of object.dataType

method

Valid values of object.method

responseType

Valid values of object.responseType

cors_mode

Valid values of CORS mode

credentials

Valid values of credentials

Sample Code

Example 1

Taro.request({
  url: 'test.php', // This value for demonstration purposes only is not a real API URL.
  data: {
    x: '',
    y: ''
  },
  header: {
    'content-type': 'application/json' // Default value
  },
  success: function (res) {
    console.log(res.data)
  }
})

Example 2

const res = await Taro.request(params)

API Support