TypeScript SDK

@pontx/posthog

PostHog 采集与功能开关 API 的运营方发布 SDK,覆盖当前 PontxSpec 的全部接口。

v0.1.1Node.js 18 / 20 / 22 CIESM + CommonJSTypeScript declarationsSDK 接口覆盖 3/3

SDK 质量门禁

v0.1.1 对应源码已在 Node.js 18 / 20 / 22 完成 100% UT 通过率与构建产物 E2E。

SDK quality: UT 100%, E2E passed
单元测试
4/4 · 100%
E2E
通过
测试提交
c82b759
验证日期
2026-08-24

安装并调用

SDK 由 Pontx 生成器产生,并在发布前完成类型检查与构建验证。

安装 SDK
pnpm add @pontx/posthog
TypeScript 调用
import { createPostHogClient } from "@pontx/posthog";

const client = createPostHogClient({
  projectToken: process.env.POSTHOG_PROJECT_TOKEN!
});

const sdkRequestBody = {
  "api_key": "REPLACE_WITH_API_KEY",
  "event": "REPLACE_WITH_EVENT",
  "distinct_id": "REPLACE_WITH_DISTINCT_ID"
} satisfies Parameters<typeof client.capture.captureEvent>[0];

const result = await client.capture.captureEvent(
  sdkRequestBody
);
console.log(result);

命令行调用

此 npm 包同时发布面向该 API 的独立 CLI;先用 dry-run 检查参数,再按供应商要求提供自己的凭证。

独立 API CLI
pnpm add --global @pontx/posthog

pontx-posthog preview captureEvent --json '{"event":"checkout_completed","distinct_id":"user_123"}'
pontx-posthog execute captureEvent --json '{"event":"checkout_completed","distinct_id":"user_123"}' --confirm