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

    类型别名 CompanionPrepareProgress

    CompanionPrepareProgress:
        | { loaded: number; phase: "downloading"; total?: number }
        | { phase: "verifying"; processed: number; total: number }
        | { phase: "extracting"; processed: number; total: number }

    Host 持有的 Companion 准备操作的最近进度快照。

    类型声明

    • { loaded: number; phase: "downloading"; total?: number }
      • loaded: number

        Host 已下载的非负安全整数计数。

      • phase: "downloading"

        下载阶段判别值。

      • 可选total?: number

        Host 已知总量;未知时省略,存在时为不小于 loaded 的非负安全整数。

    • { phase: "verifying"; processed: number; total: number }
      • phase: "verifying"

        校验阶段判别值。

      • processed: number

        Host 已校验的非负安全整数计数,且不大于 total。

      • total: number

        当前校验阶段的非负安全整数总量。

    • { phase: "extracting"; processed: number; total: number }
      • phase: "extracting"

        解压阶段判别值。

      • processed: number

        Host 已处理的非负安全整数计数,且不大于 total。

      • total: number

        当前解压阶段的非负安全整数总量。

    三个阶段的计数都是非负安全整数。Runtime 只保证同一进度对象内当前值不大于已知总量, 不定义 verifying/extracting 与下载字节之间的换算,也不保证不同阶段的 total 相同;进度 只能用于展示当前阶段,不能作为归档完整性证据。