@elysiajs/trpc

中文文档
1.1.0发布于 2024/07/16MITTypeScriptESM + CJS零依赖近 30 天下载 2.2万

Elysia 添加支持使用 tRPC 的插件

中文使用文档
文档目录5 节
  1. 安装
  2. 示例
  3. API 密码
  4. 调试c
  5. 说明

@elysiajs/trpc (英语)

用于 爱乐 添加对使用tRPC的支持.

安装

bun add @elysiajs/trpc

示例

import { Elysia, t } from 'elysia'
import { trpc, compile as c } from '@elysiajs/trpc'

import { initTRPC } from '@trpc/server'

const r = initTRPC.create()

const router = r.router({
    greet: r.procedure.input(c(t.String())).query(({ input }) => input)
})

export type Router = typeof router

const app = new Elysia()
    .use(trpc(router))
    .listen(8080)

API 密码

此插件扩展了新方法 trpc 改为 Elysia 课.

调试c

注册tRPC路由器.

type tRPC = (router: Router<any>, options?: TRPCOptions) => this

export interface TRPCOptions
    extends Omit<
        FetchHandlerRequestOptions<any>,
        'req' | 'router' | 'endpoint'
    > {
    /**
     * tRPC endpoint
     *
     * @default '/trpc'
     */
    endpoint?: string
}

说明

WebSocket API处于实验状态并不稳定.

是为了进行实验,以更好地稳定局势.

版本与发布记录

@elysiajs/trpc 共发布 31 个版本,首次发布于 2022/12/07;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.1.0latest2024/07/162 年前
1.1.0-rc.0rc2024/07/122 年前
1.0.22024/03/182 年前
1.0.02024/03/162 年前
1.0.0-rc.02024/03/012 年前
1.0.0-beta.1next2024/02/172 年前

关于 @elysiajs/trpc 的常见问题

@elysiajs/trpc 是什么?

Elysia 添加支持使用 tRPC 的插件

如何安装 @elysiajs/trpc?

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

@elysiajs/trpc 支持 TypeScript 吗?

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

@elysiajs/trpc 支持 ESM 还是 CommonJS?

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

@elysiajs/trpc 可以商用吗?

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

@elysiajs/trpc 的下载量有多少?

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

@elysiajs/trpc 还在维护吗?

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