@appport/client

中文文档
1.1.7发布于 2026/11/06Apache-2.0TypeScriptES Module近 30 天下载 2127

Transport-independent typed AppPort application client.

原始使用文档

@appport/client

The transport-independent application client.

import { createClient } from "@appport/client";

const client = createClient({ transport });
await client.connect();
await client.load(); // discovers capabilities and versions from the manifest

await client.call("documents.save", { documentId, content });
await client.capabilities.documents.save({ documentId, content });

for await (const chunk of client.stream("build.logs", { buildId })) console.log(chunk.line);

const unsubscribe = await client.events.subscribe("documents.changed", (payload) => refresh(payload));

The client builds envelopes, correlates responses, resolves capability versions from the manifest, unwraps errors into AppPortError, and exposes capabilities as a namespaced proxy. Application code never touches a protocol envelope.

If you use AppPort.discover() from @appport/client directly, pass the concrete transport factories you want discovery to use. @appport/sdk keeps the built-in HTTP and WebSocket factories wired in for the ergonomic aggregate entrypoint.

createDuplexTransport implements request correlation, subscriptions and stream reassembly once, for every carrier that can push: WebSocket, Electron IPC, Tauri IPC and the in-process bridge.

With a generated contract the client is fully typed:

import { createDocumentsClient } from "./appport/generated/client.ts";

const client = createDocumentsClient({ transport });
const { version } = await client.capabilities.documents.save({ documentId, content });

Secure discovery (1.1.0)

discoverApplication inspects an application's public description and verifies its references without connecting, authenticating or invoking. discover now refuses redirects and cross-origin transport endpoints by default (redirects: "follow" and allowOrigins are the explicit opt-ins), bounds the discovery document, and supports timeoutMs and signal. See @appport/sdk for the full description, the behavior-change table and the limits.

版本与发布记录

@appport/client 共发布 12 个版本,首次发布于 2026/09/21;过去 12 个月发布了 12 个版本。

版本发布日期距今
1.1.7latest2026/11/062 天前
1.1.62026/11/052 天前
1.1.52026/10/2810 天前
1.1.42026/10/2217 天前
1.1.32026/10/1919 天前
1.1.22026/10/1523 天前

关于 @appport/client 的常见问题

@appport/client 是什么?

Transport-independent typed AppPort application client.

如何安装 @appport/client?

在项目目录运行 npm install @appport/client,或使用 pnpm add / yarn add / bun add。

@appport/client 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@appport/client 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@appport/client 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@appport/client 可以商用吗?

@appport/client 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@appport/client 的下载量有多少?

根据 npm 官方下载统计,@appport/client 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,127 次,日均约 71 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@appport/client 还在维护吗?

最新版本 1.1.7 发布于 2026/11/06(2 天前);至今共发布 12 个版本,其中过去 12 个月发布了 12 个;首次发布于 2026/09/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。