网络

发起请求

Taro.request(OBJECT)

发起网络请求，支持 Promise 化使用。

OBJECT 参数说明：

H5 端附加参数说明：

success 返回参数说明：

示例代码：

import Taro from '@tarojs/taro'
Taro.request({
  url: 'http://localhost:8080/test',
  data: {
    foo: 'foo',
    bar: 10
  },
  header: {
    'content-type': 'application/json'
  }
})
  .then(res => console.log(res.data))

API 支持度

上传、下载

Taro.uploadFile(OBJECT)

使用方式同 wx.uploadFile，支持 Promise 化使用。

示例代码：

import Taro from '@tarojs/taro'
const uploadTask = Taro.uploadFile(params).then(...)

Taro.downloadFile(OBJECT)

使用方式同 wx.downloadFile，支持 Promise 化使用。

示例代码：

import Taro from '@tarojs/taro'
Taro.downloadFile(params).then(...)

API 支持度

WebSocket

Taro.connectSocket(OBJECT)

创建一个 WebSocket 链接。

支持存在最多两个 WebSocket 链接，每次成功调用 Taro.connectSocket 会返回一个新的 SocketTask。

OBJECT 参数说明：

示例代码：

import Taro from '@tarojs/taro'
Taro.connectSocket({
  url: 'ws://echo.websocket.org/echo',
  success: function () {
    console.log('connect success')
  }
}).then(task => {
  task.onOpen(function () {
    console.log('onOpen')
    task.send({ data: 'xxx' })
  })
  task.onMessage(function (msg) {
    console.log('onMessage: ', msg)
    task.close()
  })
  task.onError(function () {
    console.log('onError')
  })
  task.onClose(function (e) {
    console.log('onClose: ', e)
  })
})

SocketTask

WebSocket 任务，可通过 wx.connectSocket() 接口创建返回。

属性

socketTask.readyState: websocket 当前的连接状态。

socketTask.CONNECTING: websocket 状态值：连接中。

socketTask.OPEN: websocket 状态值：已连接。

socketTask.CLOSING: websocket 状态值：关闭中。

socketTask.CLOSED: websocket 状态值：已关闭。

socketTask.ws: 浏览器 websocket 实例。（h5 端独有）

方法

SocketTask.send(OBJECT)

通过 WebSocket 连接发送数据。

OBJECT 参数说明：

SocketTask.close(OBJECT)

关闭 WebSocket 连接。

OBJECT 参数说明：

SocketTask.onOpen(CALLBACK)

监听 WebSocket 连接打开事件。

SocketTask.onClose(CALLBACK)

监听 WebSocket 连接关闭事件。

CALLBACK 返回参数

SocketTask.onError(CALLBACK)

监听 WebSocket 错误。

CALLBACK 返回参数

SocketTask.onMessage(CALLBACK)

监听 WebSocket 接受到服务器的消息事件。

CALLBACK 返回参数

Taro.onSocketOpen

@Deprecated 请使用 SocketTask.onOpen

Taro.onSocketError

@Deprecated 请使用 SocketTask.onError

Taro.sendSocketMessage

@Deprecated 请使用 SocketTask.send

Taro.onSocketMessage

@Deprecated 请使用 SocketTask.onMessage

Taro.closeSocket

@Deprecated 请使用 SocketTask.close

Taro.onSocketClose

@Deprecated 请使用 SocketTask.onClose

API 支持度