title: RequestTask

sidebar_label: RequestTask

Requests tasks over the network.

Methods

abort

Aborts requesting tasks.

Reference

  1. () => void

API Support

API WeChat Mini-Program H5 React Native
RequestTask.abort ✔️

offHeadersReceived

Un-listens on the HTTP Response Header event.

Reference

  1. (callback: (res: CallbackResult) => void) => void
Property Type Description
callback (res: CallbackResult) => void The callback function for the HTTP Response Header event.

API Support

API WeChat Mini-Program H5 React Native
RequestTask.offHeadersReceived ✔️

onHeadersReceived

Listens on HTTP Response Header event, which will be earlier than the request completion event.

Reference

  1. (callback: (result: OnHeadersReceivedCallbackResult) => void) => void
Property Type Description
callback (result: OnHeadersReceivedCallbackResult) => void The callback function for the HTTP Response Header event.

API Support

API WeChat Mini-Program H5 React Native
RequestTask.onHeadersReceived ✔️

Parameters

OnHeadersReceivedCallbackResult

Property Type Description
header Record<string, any> HTTP Response Header returned by the developer server

Sample Code

Example 1

  1. const requestTask = Taro.request({
  2. url: 'test.php', // This value for demonstration purposes only is not a real API URL.
  3. data: {
  4. x: '' ,
  5. y: ''
  6. },
  7. header: {
  8. 'content-type': 'application/json' // 默认值
  9. },
  10. success: function (res) {
  11. console.log(res.data)
  12. }
  13. })
  14. requestTask.abort()

Example 2

  1. const requestTask = Taro.request({
  2. url: 'test.php', // This value for demonstration purposes only is not a real API URL.
  3. data: {
  4. x: '' ,
  5. y: ''
  6. },
  7. header: {
  8. 'content-type': 'application/json' // Default value
  9. },
  10. success: function (res) {
  11. console.log(res.data)
  12. }
  13. })
  14. requestTask.then(res => {
  15. console.log(res.data)
  16. })
  17. requestTask.abort()

Example 3

  1. const requestTask = Taro.request(params)
  2. const res = await requestTask
  3. requestTask.abort()

API Support

API WeChat Mini-Program H5 React Native
RequestTask.abort ✔️
RequestTask.offHeadersReceived ✔️
RequestTask.onHeadersReceived ✔️