请求方法

发起网络请求

请求参数

值	类型	必备	默认值	描述	兼容性
url	string	是	-	开发者服务器接口地址
data	UTSJSONObject	否	-	请求的参数
header	UTSJSONObject	否	-	设置请求的 header，header 中不能设置 Referer
requestTimeout	number	否	60000	超时时间，单位 ms
withCredentials	boolean	否	false	跨域请求时是否携带凭证（cookies）	微信小程序 / Web
firstIpv4	boolean	否	false	DNS解析时优先使用ipv4	微信小程序
enableChunked	boolean	否	false	开启 transfer-encoding chunked
closeInterceptor	boolean	否	false	关闭当前请求的拦截器
success	(option: UTSJSONObject) => void	否	null	网络请求成功回调
fail	(option: UTSJSONObject) => void	否	null	网络请求失败回调
complete	(option: UTSJSONObject) => void	否	null	网络请求完成回调，成功或者失败都会调用。
requestTask	(task : RequestTask) => void	否	-	RequestTask 的方法

success返回值

值	类型	必备	默认值	描述	兼容性
data	UTSJSONObject	否	-	开发者服务器返回的数据
statusCode	number	是	-	开发者服务器返回的 HTTP 状态码
header	any	是	-	开发者服务器返回的 HTTP Response Header
cookies	Array<string>	是	-	开发者服务器返回的 cookies，格式为字符串数组	不支持web

fail返回值

值	类型	必备	默认值	描述	兼容性
errCode	number	是	-	错误码
errSubject	string	是	-	统一错误主题（模块）名称
data	any	否	-	错误信息中包含的数据	微信小程序
cause	Error	否	-	源错误信息，可以包含多个错误，详见SourceError
errMsg	string	是	-

errCode合法值

值	描述
5	接口超时
1000	服务端系统错误
100001	json数据解析错误
100002	错误信息json解析失败
100003	json解析类型转换失败
600003	网络中断
600008	data参数类型不合法
600009	URL格式不合法
602001	request系统错误

GET 请求

<script setup>
	import { http } from "@/uni_modules/ucs-request";
	
	http.get({
		url: '/xxx',
		success: (res) => {
			console.log(res)
		},
		fail: (fail) => {
			console.log(fail)
		},
		complete: (e) => {
			console.log(e)
		}
	})
</script>

POST 请求

<script setup>
	import { http } from "@/uni_modules/ucs-request";
	
	http.post({
		url: '/xxx',
		success: (res) => {
			console.log(res)
		},
		fail: (fail) => {
			console.log(fail)
		},
		complete: (e) => {
			console.log(e)
		}
	})
</script>

PUT 请求

<script setup>
	import { http } from "@/uni_modules/ucs-request";
	
	http.put({
		url: '/xxx',
		success: (res) => {
			console.log(res)
		},
		fail: (fail) => {
			console.log(fail)
		},
		complete: (e) => {
			console.log(e)
		}
	})
</script>

PATCH 请求

<script setup>
	import { http } from "@/uni_modules/ucs-request";
	
	http.patch({
		url: '/xxx',
		success: (res) => {
			console.log(res)
		},
		fail: (fail) => {
			console.log(fail)
		},
		complete: (e) => {
			console.log(e)
		}
	})
</script>

DELETE 请求

<script setup>
	import { http } from "@/uni_modules/ucs-request";
	
	http.delete({
		url: '/xxx',
		success: (res) => {
			console.log(res)
		},
		fail: (fail) => {
			console.log(fail)
		},
		complete: (e) => {
			console.log(e)
		}
	})
</script>

HEAD 请求

<script setup>
	import { http } from "@/uni_modules/ucs-request";
	
	http.dead({
		url: '/xxx',
		success: (res) => {
			console.log(res)
		},
		fail: (fail) => {
			console.log(fail)
		},
		complete: (e) => {
			console.log(e)
		}
	})
</script>

OPTIONS 请求

<script setup>
	import { http } from "@/uni_modules/ucs-request";
	
	http.options({
		url: '/xxx',
		success: (res) => {
			console.log(res)
		},
		fail: (fail) => {
			console.log(fail)
		},
		complete: (e) => {
			console.log(e)
		}
	})
</script>

RequestTask 方法

abort(): void

abort 中断网络请求

onChunkReceived(listener: RequestTaskOnChunkReceivedCallback): number

onChunkReceived 监听 Transfer-Encoding Chunk Received 事件

值	类型	必备	默认值	描述
listener	(result: RequestTaskOnChunkReceivedListenerResult) => void	是	-	-

RequestTaskOnChunkReceivedListenerResult属性值

值	类型	必备	默认值	描述
data	ArrayBuffer	是	-	返回的chunk buffer

offChunkReceived(listener ?: number | RequestTaskOnChunkReceivedCallback | null): void

offChunkReceived 移除 Transfer-Encoding Chunk Received 事件的监听函数

值	类型	必备	默认值	描述
listener	number	(result: RequestTaskOnChunkReceivedListenerResult) => void	是	-

onHeadersReceived(listener: RequestTaskOnHeadersReceivedCallback): number

onHeadersReceived 监听 HTTP Response Header 事件

值	类型	必备	默认值	描述
listener	(result: RequestTaskOnHeadersReceivedListenerResult) => void	是	-	HTTP Response Header 事件的监听函数

RequestTaskOnHeadersReceivedListenerResult属性值

值	类型	必备	默认值	描述
cookies	Array<string>	是	-	开发者服务器返回的 cookies，格式为字符串数组
header	UTSJSONObject	是	-	开发者服务器返回的 HTTP Response Header
statusCode	number	是	-	开发者服务器返回的 HTTP 状态码 （目前开发者工具上不会返回 statusCode 字段，可用真机查看该字段，后续将会支持）

offHeadersReceived(listener ?: number | RequestTaskOnHeadersReceivedCallback | null): void

offHeadersReceived 移除 HTTP Response Header 事件的监听函数

值	类型	必备	默认值	描述
listener	(result: RequestTaskOnHeadersReceivedListenerResult) => void	是	-	HTTP Response Header 事件的监听函数