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

    接口 CompanionInfo

    Host 针对当前小程序版本与当前平台确认的 Companion 描述快照。

    Runtime 会校验字段、去重并冻结 capabilities,再返回冻结对象;页面不应修改或缓存为 跨版本事实。该结构刻意不包含准备 state、进度、preparedAt、Session ID、PID、物理 路径、下载 URL、SHA-256、entrypoint 或单独的 Companion 版本号。

    准备状态通过 companion.getPreparationStatus() 查询。Companion 随当前小程序审核版本、 精确预览版本或本地开发快照绑定;source 只说明来源类别,不提供版本号,也不能用于 比较版本新旧。

    interface CompanionInfo {
        alias: string;
        archiveBytes: number;
        capabilities: readonly CompanionCapability[];
        displayName: string;
        signatureStatus: CompanionSignatureStatus;
        source?: "preview" | "local-dev" | "released";
        target: CompanionTarget;
    }
    索引

    属性

    alias: string

    规范 alias;必须与请求值及 package.json#heybox.companions 中的 key 完全一致。

    archiveBytes: number

    当前压缩归档大小,单位字节;是大于等于 0 的安全整数,不是解压后磁盘占用。

    capabilities: readonly CompanionCapability[]

    当前产物声明且 Host 确认的去重能力列表;可能为空,不代表产物已准备或已启动。

    displayName: string

    Host 确认的用户可见名称,只用于展示;不要把它当作稳定标识、文件名或版本号。

    signatureStatus: CompanionSignatureStatus

    Host 对当前制品给出的签名检查状态;不能替代完整性校验或系统安全判断。

    source?: "preview" | "local-dev" | "released"

    Host 确认的产物来源。

    local-dev 是当前 hb-sdk dev 绑定的本地快照;preview 是精确审核前预览版本; released 是已发布版本。旧 Host 缺省时为 undefined,只表示来源未知,不应回退为 released。不要根据 alias、displayName、签名状态或页面 URL 自行推断来源。

    当前 Host 选中的目标制品;不是项目声明的全部 target。