# Interface: RequestParams ‹Err

RequestParamsErr›()

# Type parameters:

Err: MogsRes

# Type parameters

Err: MogsRes

# Properties

# Optional Readonly data

data? : string | Record‹string, any› | ArrayBuffer

请求的参数

description 最终发送给服务器的数据是 String 类型,如果传入的 data 不是 String 类型,会被转换成 String。转换规则如下:

  • 对于 GET 方法的数据,会将数据转换成 query string (encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...);
  • 对于 POST 方法且 header['Content-Type'] 为 application/json 的数据,会对数据进行 JSON 序列化;
  • 对于 POST 方法且 header['Content-Type'] 为 application/x-www-form-urlencoded 的数据,会将数据转换成 query string (encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...);

Returns: string | Record‹string, any› | ArrayBuffer


# Optional Readonly dataType

dataType? : "json" | string

返回的数据格式

description 可选值:

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

default 'json'

Returns: "json" | string


# Optional Readonly enableCache

enableCache? : boolean

开启 cache

default false

Returns: boolean


# Optional Readonly enableHttp2

enableHttp2? : boolean

开启 http2

default false

Returns: boolean


# Optional Readonly enableQuic

enableQuic? : boolean

开启 quic

default false

Returns: boolean


# Optional Readonly header

header? : Record‹string, any›

设置请求的 header

description header 中不能设置 Referer

description Content-Type 默认为 application/json

Returns: Record‹string, any›


# Optional Readonly method

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

HTTP 请求方法

description 可选值:

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

default 'GET'

Returns: "OPTIONS" | "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "TRACE" | "CONNECT"


# Optional Readonly responseType

responseType? : "text" | "arraybuffer"

响应的数据类型

description 可选值:

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

default 'text'

Returns: "text" | "arraybuffer"


# Optional Readonly timeout

timeout? : number

超时时间

description 单位为毫秒。

Returns: number


# Readonly url

url: string

开发者服务器接口地址

Returns: string

# Methods

# Optional complete

complete(res: RequestRes | Err): void

Inherited from MogsParams.complete

接口调用结束的回调函数(调用成功、失败都会执行)

# 参数:

属性 类型
res RequestRes | Err

# 返回值:

void


# Optional fail

fail(err: Err): void

Inherited from MogsParams.fail

接口调用失败的回调函数

# 参数:

属性 类型
err Err

# 返回值:

void


# Optional success

success(res: RequestRes): void

Inherited from MogsParams.success

接口调用成功的回调函数

# 参数:

属性 类型
res RequestRes

RequestRes

属性 类型 描述
cookies string[] 开发者服务器返回的 cookies
data string | Record‹string, any› | ArrayBuffer 开发者服务器返回的数据
errMsg string API 调用成功/失败的消息
header Record‹string, any› 开发者服务器返回的 HTTP Response Header
profile Profile 网络请求过程中一些调试信息
statusCode number 开发者服务器返回的 HTTP 状态码

# 返回值:

void