@heybox/hb-sdk API Reference - v0.9.5
    正在准备搜索索引...

    接口 DownloadBaseOptions

    流式下载两种 target 分支共享的地址、限制、取消与进度选项。

    下载固定使用 GET、拒绝重定向,不接受 method、data、body、Range/If-Range/A-IM 等部分响应字段。响应字节由 Host 直接写入临时目标,不经过 iframe bridge。

    interface DownloadBaseOptions {
        headers?: MiniProgramNetworkHeaders;
        maxBytes?: number;
        onProgress?: (progress: DownloadProgress) => void;
        params?: MiniProgramNetworkParams;
        signal?: AbortSignal;
        timeout?: number;
        url: string;
    }
    索引

    属性

    请求头;必须是合法的字符串字典。Host/framing/hop-by-hop、平台保留认证头以及 Range、If-Range、A-IM 会以 INVALID_PARAMS 拒绝。普通 Authorization / Cookie 不会被 Runtime 一律拒绝,但移动端下载不会自动附带 Host credential;鉴权资源优先使用 短期签名 URL。

    maxBytes?: number

    单次下载可提交的最大字节数;必须是正的 safe integer。可信 Content-Length 已超限时 会在写入前返回 FILE_TOO_LARGE,流式传输过程中超限也不会提交部分文件。 省略时 SDK 与 Runtime 不附加该字节上限,但仍受 Host 文件与传输限制;不能视为无限容量。

    onProgress?: (progress: DownloadProgress) => void

    接收当前下载的标准化 DownloadProgress。回调本身不会序列化到 bridge;回调抛错 不会中断下载。lengthComputable 为 false 时不要按 total 计算百分比。

    查询参数;必须是对象,SDK 会复制后交给 Host 编码到下载 URL。

    signal?: AbortSignal

    用于取消当前下载。调用前已 aborted 会立即返回 DOWNLOAD_CANCELLED;提交前取消获胜时 原目标保持不变,Host 已完成原子提交时则成功结果优先。

    timeout?: number

    网络与响应 body 的空闲超时,单位毫秒;必须是有限正数,不是整个下载的总时长。 省略时 SDK 与 Runtime 不设置统一默认值,由 Host 采用自身策略;需要确定超时预算时显式传入。

    url: string

    下载地址。必须是无 username/password 的 HTTP(S) URL;生产环境只允许 HTTPS,本地开发 仅允许 Host 明确放行的 loopback/LAN HTTP origin。当前公开 Host 的流式下载 adapter 不支持 小黑盒官方域名,即使 network.useOfficialDomain 已声明并获批也不应依赖;Runtime/账号 敏感路径始终禁止访问。