@goperigon/perigon-ts

中文文档
6.1.0发布于 2026/11/16MITTypeScriptESM + CJS近 30 天下载 5389

Perigon API 的打字客户端

中文使用文档
文档目录13 节
  1. * 特性
  2. * 安装
  3. QQ 快速启动
  4. 认证
  5. 终点
  6. 新闻文章( E)
  7. 实体
  8. 内容发现
  9. AI 特性
  10. 知识库
  11. 未宣布参数
  12. QQ 错误处理
  13. 许可证

Perigon logo

Perigon 类型脚本 SDK

类型脚本客户端 佩里贡 API

npm version tests status documentation license

用于Perigon API的全型TypeScript SDK. 获取新闻文章,AI摘要,实体数据,以及更多与完全类型安全相关的内容.

* 特性

  • 类型安全 - 用 IntelliSense 支持完整类型脚本
  • 通用 - 在Node.js、浏览器、Deno和边缘运行时间工作
  • 零依赖关系 -轻量级核心,带回你自己的取回器
  • 自动生成 – 总是与最新的 API 同步

* 安装

npm install @goperigon/perigon-ts
# yarn add @goperigon/perigon-ts
# pnpm add @goperigon/perigon-ts
# bun add @goperigon/perigon-ts

QQ 快速启动

import { Configuration, V1Api } from "@goperigon/perigon-ts";

const perigon = new V1Api(
  new Configuration({
    apiKey: process.env.PERIGON_API_KEY,
  }),
);

try {
  const { articles } = await perigon.searchArticles({
    q: "artificial intelligence",
    size: 5,
  });
  console.log(`Found ${articles.length} articles`);
} catch (error) {
  console.error("API Error:", error.message);
}

认证

获取您的 API 密钥 近地点.io数字 :

# Environment variable (recommended)
export PERIGON_API_KEY="your_api_key_here"
// Or pass directly
const perigon = new V1Api(
  new Configuration({
    apiKey: "your_api_key_here",
  }),
);

请求 https://api.perigon.io 默认。 把他们送到别的地方,比如通过代理,通过 basePath: "https://your-host" 改为 Configuration。 。 。 .

终点

新闻文章( E)

const { articles, numResults } = await perigon.searchArticles({
  q: "technology AND startups",
  source: ["techcrunch.com"],
  from: new Date("2024-01-01"),
  size: 10,
});

实体

const { results } = await perigon.searchCompanies({ name: "Apple", size: 5 });

内容发现

const { results } = await perigon.searchStories({
  q: "climate change",
  size: 5,
});

AI 特性

const { summary } = await perigon.searchSummarizer({
  q: "renewable energy",
  summaryBody: {
    prompt: "Summarize the main developments in renewable energy.",
    maxArticleCount: 10,
  },
});
  • searchSummarizer - 从关于任何专题的多篇文章中生成AI强势摘要

知识库

const { results } = await perigon.searchWikipedia({
  q: "machine learning",
  size: 10,
});

未宣布参数

宣告的请求参数被验证; TypeScript 拒绝未宣布的参数. 要发送查询参数, API 接受, 但这个 SDK 版本尚未声明, 请通过 extraParams数字 :

const { results } = await perigon.searchStories({
  q: "climate change",
  extraParams: { someNewFilter: "value" },
});

extraParams 接受字符串、数字、布尔斯、单一日期以及字符串、数字或布尔斯等数组; null 财务报告和审定财务报表 undefined 数值被省略。 这些值覆盖了同名已声明的参数,而不检查已声明参数的类型. 绕过类型(如从JavaScript)的未声明的顶级密钥被丢弃.

QQ 错误处理

所有错误延伸 ResponseError 包含 status 打开 body 属性 :

try {
  const result = await perigon.searchArticles({ q: "test" });
} catch (error) {
  if (error.status === 401) console.error("Invalid API key");
  else if (error.status === 429) console.error("Rate limit exceeded");
  else console.error("API Error:", error.message);
}

许可证

麻省理工学院

版本与发布记录

@goperigon/perigon-ts 共发布 27 个版本,首次发布于 2025/05/02;过去 12 个月发布了 9 个版本。

版本发布日期距今
6.1.0latest2026/11/16今天
6.0.02026/10/2919 天前
5.0.02026/10/1928 天前
4.10.02026/06/035 个月前
4.9.02026/05/225 个月前
4.7.02026/05/076 个月前

关于 @goperigon/perigon-ts 的常见问题

@goperigon/perigon-ts 是什么?

Perigon API 的打字客户端

如何安装 @goperigon/perigon-ts?

在项目目录运行 npm install @goperigon/perigon-ts,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:undici(>=5)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@goperigon/perigon-ts 支持 TypeScript 吗?

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

@goperigon/perigon-ts 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@goperigon/perigon-ts 可以商用吗?

@goperigon/perigon-ts 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@goperigon/perigon-ts 的下载量有多少?

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

@goperigon/perigon-ts 还在维护吗?

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