Interface WechatRequestBaseConfig

RequestBaseConfig 请求配置

interface WechatRequestBaseConfig {
    baseUrl?: string;
    data?: string | ArrayBuffer | IAnyObject;
    dataType?: "json" | "其他";
    enableCache?: boolean;
    enableChunked?: boolean;
    enableHttp2?: boolean;
    enableHttpDNS?: boolean;
    enableProfile?: boolean;
    enableQuic?: boolean;
    forceCellularNetwork?: boolean;
    getResponse?: boolean;
    header?: IAnyObject;
    httpDNSServiceId?: string;
    ignoreLoading?: boolean;
    method?:
        | "GET"
        | "POST"
        | "PUT"
        | "DELETE"
        | "HEAD"
        | "OPTIONS"
        | "TRACE"
        | "CONNECT";
    params?: any;
    redirect?: "follow" | "manual";
    responseType?: "arraybuffer" | "text";
    timeout?: number;
    url?: string;
    useHighPerformanceMode?: boolean;
}

Hierarchy

  • Partial<Omit<WechatMiniprogram.RequestOption, "success" | "fail" | "complete">>
    • WechatRequestBaseConfig

Properties

baseUrl? data? dataType? enableCache? enableChunked? enableHttp2? enableHttpDNS? enableProfile? enableQuic? forceCellularNetwork? getResponse? header? httpDNSServiceId? ignoreLoading? method? params? redirect? responseType? timeout? url? useHighPerformanceMode?

Properties

OptionalbaseUrl

baseUrl?: string

公共url

Optionaldata

data?: string | ArrayBuffer | IAnyObject

请求的参数

OptionaldataType

dataType?: "json" | "其他"

返回的数据格式

可选值：

  • 'json': 返回的数据为 JSON，返回后会对返回的数据进行一次 JSON.parse;
  • '其他': 不对返回的内容进行 JSON.parse;

OptionalenableCache

enableCache?: boolean

需要基础库： 2.10.4

开启 Http 缓存

OptionalenableChunked

enableChunked?: boolean

需要基础库： 2.20.2

开启 transfer-encoding chunked。

OptionalenableHttp2

enableHttp2?: boolean

需要基础库： 2.10.4

开启 http2

OptionalenableHttpDNS

enableHttpDNS?: boolean

需要基础库： 2.19.1

是否开启 HttpDNS 服务。如开启，需要同时填入 httpDNSServiceId 。 HttpDNS 用法详见 移动解析HttpDNS

OptionalenableProfile

enableProfile?: boolean

是否开启 profile，默认开启。开启后可在接口回调的 res.profile 中查看性能调试信息。

OptionalenableQuic

enableQuic?: boolean

需要基础库： 2.10.4

开启 Quic 协议（gQUIC Q43）

OptionalforceCellularNetwork

forceCellularNetwork?: boolean

需要基础库： 2.21.0

强制使用蜂窝网络发送请求

OptionalgetResponse

getResponse?: boolean

返回原生响应 AppResponse 默认false

Optionalheader

header?: IAnyObject

设置请求的 header，header 中不能设置 Referer。

content-type 默认为 application/json

OptionalhttpDNSServiceId

httpDNSServiceId?: string

需要基础库： 2.19.1

HttpDNS 服务商 Id。 HttpDNS 用法详见 移动解析HttpDNS

OptionalignoreLoading

ignoreLoading?: boolean

忽略 loading 提示

Optionalmethod

method?:
    | "GET"
    | "POST"
    | "PUT"
    | "DELETE"
    | "HEAD"
    | "OPTIONS"
    | "TRACE"
    | "CONNECT"

HTTP 请求方法

可选值：

  • 'OPTIONS': HTTP 请求 OPTIONS;
  • 'GET': HTTP 请求 GET;
  • 'HEAD': HTTP 请求 HEAD;
  • 'POST': HTTP 请求 POST;
  • 'PUT': HTTP 请求 PUT;
  • 'DELETE': HTTP 请求 DELETE;
  • 'TRACE': HTTP 请求 TRACE;
  • 'CONNECT': HTTP 请求 CONNECT;

Optionalparams

params?: any

get 请求参数

Optionalredirect

redirect?: "follow" | "manual"

需要基础库： 3.2.2

重定向拦截策略。（目前安卓、iOS、开发者工具已支持，PC端将在后续支持）

可选值：

  • 'follow': 不拦截重定向，即客户端自动处理重定向;
  • 'manual': 拦截重定向。开启后，当 http 状态码为 3xx 时客户端不再自动重定向，而是触发 onHeadersReceived 回调，并结束本次 request 请求。可通过 onHeadersReceived 回调中的 header.Location 获取重定向的 url;

OptionalresponseType

responseType?: "arraybuffer" | "text"

需要基础库： 1.7.0

响应的数据类型

可选值：

  • 'text': 响应的数据为文本;
  • 'arraybuffer': 响应的数据为 ArrayBuffer;

Optionaltimeout

timeout?: number

需要基础库： 2.10.0

超时时间，单位为毫秒。默认值为 60000

Optionalurl

url?: string

开发者服务器接口地址

OptionaluseHighPerformanceMode

useHighPerformanceMode?: boolean

需要基础库： 3.3.3

使用高性能模式，暂仅支持 Android，默认关闭。该模式下有更优的网络性能表现，更多信息请查看下方说明。

Settings

Member Visibility

On This Page

Properties