minigame-std
    Preparing search index...

    Interface UploadFileOptions

    上传文件的选项。

    1.0.0

    import { fs, type UploadFileOptions } from 'minigame-std';

    const options: UploadFileOptions = {
        name: 'file',
        formData: { key: 'value' },
    };
    const task = fs.uploadFile('/path/to/file.txt', 'https://example.com/upload', options);
    interface UploadFileOptions {
        complete?: UploadFileCompleteCallback;
        enableHttp2?: boolean;
        enableProfile?: boolean;
        enableQuic?: boolean;
        formData?: IAnyObject;
        header?: IAnyObject;
        name?: string;
        timeout?: number;
    }

    Hierarchy

    • Omit<
          WechatMinigame.UploadFileOption,
          "url"
          | "filePath"
          | "name"
          | "success"
          | "fail",
      >
      • UploadFileOptions
    Index

    Properties

    complete? enableHttp2? enableProfile? enableQuic? formData? header? name? timeout?

    Properties

    complete?: UploadFileCompleteCallback

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

    enableHttp2?: boolean

    需要基础库： 2.10.4

    是否开启 http2

    enableProfile?: boolean

    需要基础库： 3.5.0

    是否开启 profile。iOS 和 Android 端默认开启，其他端暂不支持。开启后可在接口回调的 res.profile 中查看性能调试信息。

    enableQuic?: boolean

    需要基础库： 2.10.4

    是否开启 Quic/h3 协议（iOS 微信目前使用 gQUIC-Q43；Android 微信在 v8.0.54 前使用 gQUIC-Q43，v8.0.54 开始使用 IETF QUIC，即 h3 协议；PC微信使用 IETF QUIC，即 h3 协议）

    formData?: IAnyObject

    HTTP 请求中其他额外的 form data

    header?: IAnyObject

    HTTP 请求 Header，Header 中不能设置 Referer

    name?: string

    可选的文件名称。

    timeout?: number

    需要基础库： 2.10.0

    超时时间，单位为毫秒

    Settings

    Member Visibility

    On This Page

    Properties