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

    类型别名 DownloadOptions

    DownloadOptions: DownloadBaseOptions & (
        | { overwrite?: never; suggestedName?: never; to: FileHandle }
        | { overwrite?: boolean; suggestedName?: string; to: DirectoryHandle }
    )

    下载目标选项。

    类型声明

    • { overwrite?: never; suggestedName?: never; to: FileHandle }
      • 可选overwrite?: never

        File target 固定原子替换,不接受该字段;即使显式传入 boolean 也返回 INVALID_PARAMS。

      • 可选suggestedName?: never

        File target 不接受该字段;即使显式传入字符串也返回 INVALID_PARAMS。

      • to: FileHandle

        当前 SDK session 创建的 readwrite File 代理;目标文件必须已存在。成功后返回同一代理。

    • { overwrite?: boolean; suggestedName?: string; to: DirectoryHandle }
      • 可选overwrite?: boolean

        是否允许原子创建或替换目录内的同名文件,默认 false;false 时采用独占创建。

      • 可选suggestedName?: string

        建议的安全子文件 basename。服务端安全 Content-Disposition filename* / filename 优先于该值;之后依次回退 URL basename 与 download.bin。不能包含路径分隔符、点段、 控制字符、Windows 保留名或尾随点/空格,最长 255 个 Unicode 字符。

      • to: DirectoryHandle

        当前 SDK session 创建的、已存在的 readwrite Directory 代理;成功后返回其直接子 File 代理。

    File target 必须是当前 SDK session 中已存在的 readwrite FileHandle。下载成功后 原子替换该文件并返回传入的同一个代理,不接受 suggestedName 或 overwrite。

    Directory target 必须是当前 SDK session 中已存在的 readwrite DirectoryHandle。 下载会在其中创建一个直接子文件并返回新的冻结 readwrite File 代理;默认独占创建, 同名目标返回 FILE_ALREADY_EXISTS,仅 overwrite: true 允许原子创建或替换。