用途:在构建、审查或调试 oRPC 代码时,按官方文档对齐契约定义、路由/过程/中间件、RPCHandler 或 OpenAPIHandler 及客户端接线等实现。oRPC 通过端到端类型安全的 API 定义并调用远程或本地过程,同时遵循 OpenAPI 规范。官方文档:https://orpc.dev;仓库:https://github.com/unnoq/orpc。
主要能力(文档主题):核心概念包括 Procedure、Router、Middleware、Context、Metadata、错误处理、Event Iterator(SSE)、文件上传下载、Server Action,以及与其他 RPC/REST 的对比。契约优先:定义契约、实现契约、Router 转 Contract。处理程序:RPC Handler、OpenAPI Handler、OpenAPI 路由与规范。客户端:服务端客户端、客户端客户端、RPCLink、DynamicLink、客户端错误处理、客户端 Event Iterator。适配器覆盖 HTTP、Next.js、Hono、Express、Fastify、WebSocket、Message Port、Electron、Browser,以及 Astro、Elysia、H3、Nuxt、Remix、Solid Start、SvelteKit、TanStack Start、React Native 等。插件含 CORS、请求/响应校验、批量请求、去重请求、客户端重试、Body Limit、压缩、简单 CSRF 防护、严格 GET 方法。集成含 TanStack Query、AI SDK、Better Auth、OpenTelemetry、Sentry、Pino logging、tRPC interop、NestJS。另有最佳实践(Monorepo、SSR 优化、去重中间件、No Throw Literal)与高级主题(自定义插件、测试与 Mocking、RPC 协议、RPC JSON 序列化器/SuperJson、校验错误、发布客户端到 NPM、从 tRPC 迁移)。
使用方式:oRPC 提供的是面向 LLM 的文档而非代码技能,每个参考页都是对应文档页的 Markdown 渲染(.md 后缀),只取与任务相关的页面。索引:https://orpc.dev/llms.txt;全文单文件(较大):https://orpc.dev/llms-full.txt;任意文档 URL 追加 .md 即可得到 Markdown(如 https://orpc.dev/docs/router.md)。流程:先识别涉及面(contract、router/procedure、handler、client 或集成),只读相关参考页并追加 .md,不臆测 API;客户端与服务端为独立包时优先契约优先,同处代码可直接用 router;沿用项目既有的 handler 与序列化器选择;端到端验证类型安全,抛出 Error 实例而非字面量。
适用场景:使用或维护 oRPC 的 TypeScript 项目,尤其在多包仓库、需要 OpenAPI 暴露、需要复用既有框架适配器与插件的场合。
限制与注意:不要臆造 API 表面,需按需抓取对应 .md 页面,oRPC 的 API 按版本迭代且跨主版本会变化;必须抛出 Error 实例,绝不抛字面量(oRPC 错误流与类型推断依赖这一点);保持契约与实现类型同步,让契约驱动客户端类型;尊重项目既有的 handler/序列化器/适配器选择,不要混用。关于收费、价格、平台等资料未提供。