core
    正在准备搜索索引...

    接口 RequestData

    网络请求

    interface RequestData {
        data?: string | object | Uint8Array<ArrayBuffer>;
        dataType?: string;
        dnsOverHttps?: string;
        dnsServers?: string[];
        enableCache?: boolean;
        enableChunked?: boolean;
        enableHttp2?: boolean;
        enableQuic?: boolean;
        firstIpv4?: boolean;
        forceCellularNetwork?: boolean;
        header?: Record<string, string>;
        method?:
            | "OPTIONS"
            | "GET"
            | "HEAD"
            | "POST"
            | "PUT"
            | "DELETE"
            | "TRACE"
            | "CONNECT";
        onDataReceiveProgress?: (progress: DataReceiveProgress) => void;
        onDataSendProgress?: (progress: DataSendProgress) => void;
        onNetworkTaskCreated?: (task: NetworkTask) => void;
        onReceiveResponseHeaders?: (
            responseHeaders: Record<string, string | string[]>,
        ) => void;
        responseType?: "text" | "arraybuffer";
        sslVerify?: boolean;
        timeout?: number;
        url: string;
        withCredentials?: boolean;
    }

    层级 (查看层级一览)

    索引
    data?: string | object | Uint8Array<ArrayBuffer>

    请求的参数

    dataType?: string

    返回的数据格式。值为 json 时,返回的数据为 JSON,返回后会对返回的数据进行一次 JSON.parse;其他值则不对返回的内容进行 JSON.parse

    dnsOverHttps?: string

    设置使用 HTTPS 协议的服务器进行 DNS 解析。

    • 参数必须根据以下格式进行 URL 编码:"https:// host:port/path"。
    dnsServers?: string[]

    设置指定的 DNS 服务器进行 DNS 解析。

    • 最多可以设置 3 个 DNS 解析服务器。如果有 3 个以上,只取前 3 个。
    • 服务器必须是 IPV4 或者 IPV6 地址。
    enableCache?: boolean

    开启 cache

    enableChunked?: boolean

    开启 transfer-encoding chunked

    enableHttp2?: boolean

    开启 http2

    enableQuic?: boolean

    开启 quic

    firstIpv4?: boolean

    DNS解析时优先使用 ipv4

    forceCellularNetwork?: boolean

    wifi下使用移动网络发送请求

    header?: Record<string, string>

    设置请求的 header,不能设置 Referer。

    • request 接口 content-type 默认为 application/json
    method?:
        | "OPTIONS"
        | "GET"
        | "HEAD"
        | "POST"
        | "PUT"
        | "DELETE"
        | "TRACE"
        | "CONNECT"

    方法,可选值 OPTIONS,GET,HEAD,POST,PUT,DELETE,TRACE,CONNECT

    • request 与 downloadFile 接口默认 GET
    • uploadFile 接口默认 POST
    onDataReceiveProgress?: (progress: DataReceiveProgress) => void

    数据接收(下传)进度

    onDataSendProgress?: (progress: DataSendProgress) => void

    数据发送(上传)进度

    onNetworkTaskCreated?: (task: NetworkTask) => void

    当网络任务创建成功时触发

    onReceiveResponseHeaders?: (
        responseHeaders: Record<string, string | string[]>,
    ) => void

    接收到服务器响应头

    • 鸿蒙:如果出现重定向(如 302)会收到多次回调响应
    responseType?: "text" | "arraybuffer"

    设置响应的数据类型。合法值:text、arraybuffer

    sslVerify?: boolean

    验证 ssl 证书

    timeout?: number

    超时时间,毫秒

    url: string

    资源 url

    withCredentials?: boolean

    跨域请求时是否携带凭证