AILab SDK

用于实现知乎 App 内部通信的 SDK， AI Lab 专用。

安装

npm install @zhihu/ailab-sdk

快速开始

初始化

方式一：使用 NPM 安装

import { AILabSDK } from '@zhihu/ailab-sdk';

const sdk = new AILabSDK({
  debug: true           // 开启调试日志
});

方式二：使用 CDN 引入

CDN 地址：https://unpkg.zhimg.com/@zhihu/ailab-sdk@:version/dist/index.min.js

:version 为版本号，请替换为实际版本号。显式指定版本，避免因依赖更新导致意外问题。 可以使用 npm dist-tags @zhihu/ailab-sdk 查看当前最新版本号。

<script src="https://unpkg.zhimg.com/@zhihu/[email protected]/dist/index.min.js"></script>
<script>
  const sdk = new AILab.AILabSDK({
    debug: true           // 开启调试日志
  });
</script>

使用

示例用法

// 页面导航
try {
  await sdk.navigateTo('path?key=value&key2=value2');
} catch (error) {
  console.error('导航失败:', error);
}

// 销毁实例（防止内存泄漏）
sdk.dispose();

API 文档

核心方法

dispose(): void

销毁 SDK 实例，清理所有事件监听器和挂起的消息。页面销毁前保证调用该方法，防止内存泄漏。

页面导航

navigateTo(url: string): Promise<void>

导航到当前应用下其他页面地址，会 push 进一个路由地址。不使用该方法打开链接或者操作路由，不会添加路由。

参数：

• url: 目标路径，格式为 'path?key=value&key2=value2'

openZhihuPage(url: string): Promise<void>

打开一个知乎页面。*注意：仅支持 https 协议且主域名为 .zhihu.com 的链接。

参数：

• url: 目标知乎页面地址，格式如 'https://www.zhihu.com/question/1'