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

    类型别名 CompanionPreparationStatus

    CompanionPreparationStatus:
        | { state: "not-prepared" }
        | { progress: CompanionPrepareProgress; state: "preparing" }
        | { preparedAt: number; state: "ready" }
        | { error: CompanionErrorSummary; state: "failed" }

    当前小程序版本、当前平台与指定 alias 对应的 Host 准备状态快照。

    类型声明

    • { state: "not-prepared" }
      • state: "not-prepared"

        当前版本与 target 尚无已原子提交的本地产物,也没有在途准备。

    • { progress: CompanionPrepareProgress; state: "preparing" }
      • progress: CompanionPrepareProgress

        查询时 Host 保存的最近进度;这是快照,不是持续订阅。

      • state: "preparing"

        Host 正在下载、校验或解压;页面 reload 或隐藏不会自动取消该操作。

    • { preparedAt: number; state: "ready" }
      • preparedAt: number

        Host 提供的非负安全整数准备完成时间戳。

        协议不公开时钟来源、时区或过期语义;只适合展示和诊断,不应用于授权、版本比较 或判断产物仍然有效。

      • state: "ready"

        当前版本产物已原子提交,可以由新的可信用户操作调用 launch()。

    • { error: CompanionErrorSummary; state: "failed" }
      • error: CompanionErrorSummary

        经过 Runtime 脱敏和规范化的失败摘要。

      • state: "failed"

        最近一次准备已失败,当前没有可由该状态直接启动的新产物。

    这是以 state 为判别字段的四态联合,Runtime 会冻结返回对象及嵌套的 progress 或 error。它描述 Host 持久状态,不等同于某个页面中 prepare() Promise 的状态,也不会 随后台操作自动变化;需要最新值时重新调用 companion.getPreparationStatus()。