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

    接口 CompanionPrepareOptions

    companion.prepare 的进度与取消配置。

    所有字段均可省略。SDK 会在发送请求前校验 options 必须是非 null 且非数组的对象、 signal 必须符合 AbortSignal 接口、onProgress 必须是函数;不合法时以 INVALID_PARAMS 拒绝。

    interface CompanionPrepareOptions {
        onProgress?: (progress: CompanionPrepareProgress) => void;
        signal?: AbortSignal;
    }
    索引

    属性

    onProgress?: (progress: CompanionPrepareProgress) => void

    准备阶段进度回调。

    回调接收经过 Runtime 校验的 CompanionPrepareProgress:Host 可能报告 downloading、verifying、extracting;下载 total 可以省略,其他阶段同时提供 processed 与 total。加入既有操作时,Host 可以先回放最近进度;不保证页面收到每个 中间值。回调抛错会被 SDK 隔离,不会取消 Host 操作或改变 prepare 的最终结果。

    signal?: AbortSignal

    用于向 Host 发送准备取消意图的信号。

    调用前已经 aborted 时,SDK 在发起 prepare 前以 COMPANION_PREPARATION_CANCELLED 拒绝。操作在途时触发 signal,SDK 会另发 cancelPreparation(alias),但不会使用普通 bridge cancel,也不会仅在页面本地立即 settle;最终结果仍由 Host 的取消与原子提交 竞态决定。

    同 alias 的准备由 Host 共享,因此该取消意图针对整项在途准备,不只是移除当前页面的 progress observer,其他 joiner 也可能收到取消结果。页面 reload 本身不会触发这个 signal,也不会自动取消 Host 操作。需要观察取消请求本身是否失败时,显式 await companion.cancelPreparation。