@dfeidao/atom-wxapp > api_net网络类

External module: api_net网络类

Index

Functions

• close_socket
• connect_socket
• download_file
• get
• on_socket_close
• on_socket_error
• on_socket_error
• on_socket_message
• on_socket_open
• post
• remove_uploaded_file
• reupload_file
• upload_file

Functions

close_socket

▸ close_socket(code?: undefined | number, reason?: undefined | string): Promise<boolean>

Defined in api/network/close-socket.ts:11

关闭 WebSocket 连接

see: 微信官方文档

Parameters:

Returns: Promise<boolean>

connect_socket

▸ connect_socket(url: string, header?: wx.RequestHeader, method?: “OPTIONS” | “GET” | “HEAD” | “POST” | “PUT” | “DELETE” | “TRACE” | “CONNECT”, protocols?: string[]): Promise<boolean>

Defined in api/network/connect-socket.ts:10

创建一个 WebSocket 连接

description: 使用前请注意阅读相关说明。

see: 微信官方文档 相关说明

Parameters:

Returns: Promise<boolean>

download_file

▸ download_file(url: string, header?: wx.RequestHeader): Promise<object>

Defined in api/network/download-file.ts:12

下载文件资源到本地

description: 客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径。使用前请注意阅读相关说明。注意：请在服务端响应的 header 中指定合理的 Content-Type 字段，以保证客户端正确处理文件类型。

see: 微信官方文档 相关说明

Parameters:

Returns: Promise<object>

get

▸ get(url: string, data?: any, headers?: undefined | object): Promise<DataResponse>

Defined in api/network/request.ts:43

Parameters:

Returns: Promise<DataResponse>

on_socket_close

▸ on_socket_close(): Promise<boolean>

Defined in api/network/on-socket-close.ts:9

监听 WebSocket 连接关闭事件

see: 微信官方文档

Returns: Promise<boolean>

on_socket_error

▸ on_socket_error(): Promise<boolean>

Defined in api/network/on-socket-error.ts:9

监听 WebSocket 错误事件

see: 微信官方文档

Returns: Promise<boolean>

on_socket_error

▸ on_socket_error(data: string | ArrayBuffer): Promise<boolean>

Defined in api/network/send-socket-message.ts:10

通过 WebSocket 连接发送数据

description: 需要先调 connect-socket原子操作 ，并在 on-socket-open原子操作 回调之后才能发送。

see: 微信官方文档

Parameters:

Returns: Promise<boolean>

on_socket_message

▸ on_socket_message(): Promise<DataResponse>

Defined in api/network/on-socket-message.ts:9

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

see: 微信官方文档

Returns: Promise<DataResponse>

on_socket_open

▸ on_socket_open(): Promise<boolean>

Defined in api/network/on-socket-open.ts:9

监听 WebSocket 连接打开事件

see: 微信官方文档

Returns: Promise<boolean>

post

▸ post(url: string, data: any, headers?: undefined | object): Promise<DataResponse>

Defined in api/network/request.ts:47

Parameters:

Returns: Promise<DataResponse>

remove_uploaded_file

▸ remove_uploaded_file(uri: string, file_id: string, productid: string): Promise<false | DataResponse>

Defined in api/network/remove-uploaded-file.ts:18

删除资源服务器文件

see: 删除本地文件

example:

import upload from '@dfeidao/atom-wxapp/api/network/upload-file';
const res = await remove('http://172.16.12.2', '42d3edd7-c563-4bd7-9d4b-cc30464e1215.jpg', 'escape_device');

Parameters:

Returns: Promise<false | DataResponse>

reupload_file

▸ reupload_file(uri: string, productid: string, file_id: string, filePath: string, header?: wx.RequestHeader): Promise<UploadFileResponse>

Defined in api/network/reupload-file.ts:18

重新文件

Parameters:

Returns: Promise<UploadFileResponse>

upload_file

▸ upload_file(uri: string, productid: string, filePath: string, name: string, header?: wx.RequestHeader): Promise<UploadFileResponse>

Defined in api/network/upload-file.ts:20

将本地资源上传到服务器

description: 户端发起一个 HTTPS POST 请求，其中 content-type 为 multipart/form-data。使用前请注意阅读相关说明。

see: 微信官方文档 相关说明

example:

import upload from '@dfeidao/atom-wxapp/api/network/upload-file';
const res = await upload('http://172.16.12.2', 'escape_device', '要上传的文件路径', 'test');

Parameters:

Returns: Promise<UploadFileResponse>