Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(type): update type of request #14175

Merged
merged 2 commits into from
Jul 17, 2023
Merged

fix(type): update type of request #14175

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5aa8d98
fix(type): add `forceCellularNetwork` type of wx.request
TheKonka Jul 13, 2023
54800c2
fix(type): update type of my.request
TheKonka Jul 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 60 additions & 9 deletions packages/taro/types/api/network/request.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import Taro from '../../index'

declare module '../../index' {
namespace request {
interface Option <T = any, U extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any > {
interface Option<T = any, U extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any> {
/** 开发者服务器接口地址 */
url: string
/** 请求的参数 */
Expand All @@ -14,11 +14,11 @@ declare module '../../index' {
header?: TaroGeneral.IAnyObject
/** 超时时间，单位为毫秒
* @default 2000
* @supported weapp, h5, tt
* @supported weapp, h5, tt, alipay
*/
timeout?: number
/** HTTP 请求方法
* @default GET
* @default "GET"
*/
method?: keyof Method
/** 返回的数据格式 */
Expand Down Expand Up @@ -54,6 +54,25 @@ declare module '../../index' {
* @supported weapp
*/
enableChunked?: boolean
/**
* wifi下使用移动网络发送请求
* @default false
* @supported weapp
*/
forceCellularNetwork?: boolean
/**
* headers 中设置 cookie 字段是否生效。如果为 false，则 headers 中的 cookie 字段将被忽略，请求头中将包含服务端上一次返回的 cookie（如果有）。
* @default false
* @supported alipay 支付宝: 10.2.33+
*/
enableCookie?: boolean
/**
* referer 策略，用于控制当前请求 header 对象中 referer 字段格式。该参数默认值可通过 app.json 中的配置进行修改。
* @default "querystring"
* @supported alipay 支付宝: 10.3.50+ APPX: 2.8.7 开发者工具: 3.5.1
* @see https://opendocs.alipay.com/mini/api/owycmh#referrerStrategy%20%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E
*/
referrerStrategy?: keyof ReferrerStrategy
/** 接口调用成功的回调函数 */
success?: (result: SuccessCallbackResult<T>) => void
/** 接口调用失败的回调函数 */
Expand Down Expand Up @@ -120,7 +139,8 @@ declare module '../../index' {
storeCheck?(): boolean
}

interface SuccessCallbackResult < T extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any > extends TaroGeneral.CallbackResult {
interface SuccessCallbackResult<T extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any>
extends TaroGeneral.CallbackResult {
/** 开发者服务器返回的数据 */
data: T
/** 开发者服务器返回的 HTTP Response Header */
Expand All @@ -135,10 +155,26 @@ declare module '../../index' {

/** 返回的数据格式 */
interface DataType {
/** 返回的数据为 JSON，返回后会对返回的数据进行一次 JSON.parse
/**
* 返回的数据为 JSON，返回后会对返回的数据进行一次 JSON.parse
* 其他: 不对返回的内容进行 JSON.parse
*/
json
/**
* 返回的数据为文本字符串
* @supported alipay
*/
text
/**
* 返回的数据将转换为 base64 格式字符串
* @supported alipay
*/
base64
/**
* 返回的数据将保持 ArrayBuffer 数据
* @supported alipay 支付宝: 10.1.70+
*/
arraybuffer
}

/** HTTP 请求方法 */
Expand Down Expand Up @@ -202,6 +238,21 @@ declare module '../../index' {
/** 浏览器在其HTTP缓存中寻找匹配的请求 */
'only-if-cached'
}
/** referer 策略 */
interface ReferrerStrategy {
/**
* referer 值为 https://{appid}.hybrid.alipay-eco.com/{appid}/{version}/index.html
*/
index
/**
* 保留 page（pages/xxx/yyy），referer 值为 https://{appid}.hybrid.alipay-eco.com/{appid}/{version}/index.html#{page}
*/
page
/**
* 默认值。会将发起请求时所在页面的 URL 作为 referer 值，会保留 page（pages/xxx/yyy）和 querystring（x=1&y=2）并可能有框架添加的其他参数，referer 值为 https://{appid}.hybrid.alipay-eco.com/{appid}/{version}/index.html#{page}?{querysrtring}{框架其他参数}
*/
querystring
}
}

/** 网络请求任务对象
Expand Down Expand Up @@ -269,31 +320,31 @@ declare module '../../index' {
*/
onHeadersReceived(
/** HTTP Response Header 事件的回调函数 */
callback: RequestTask.onHeadersReceived.Callback,
callback: RequestTask.onHeadersReceived.Callback
): void
/** 取消监听 HTTP Response Header 事件
* @supported weapp
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.offHeadersReceived.html
*/
offHeadersReceived(
/** HTTP Response Header 事件的回调函数 */
callback: RequestTask.onHeadersReceived.Callback,
callback: RequestTask.onHeadersReceived.Callback
): void
/** 监听 Transfer-Encoding Chunk Received 事件。当接收到新的chunk时触发。
* @supported weapp
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.onChunkReceived.html
*/
onChunkReceived(
/** Transfer-Encoding Chunk Received 事件的回调函数 */
callback: RequestTask.onChunkReceived.Callback,
callback: RequestTask.onChunkReceived.Callback
): void
/** 移除 Transfer-Encoding Chunk Received 事件的监听函数
* @supported weapp
* @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.offChunkReceived.html
*/
offChunkReceived(
/** Transfer-Encoding Chunk Received 事件的回调函数 */
callback: RequestTask.onChunkReceived.Callback,
callback: RequestTask.onChunkReceived.Callback
): void
}

Expand Down