メインコンテンツにスキップ
バージョン: 11.x

ルーターの定義

tRPC ベースの API の構築を開始するには、最初にルーターを定義する必要があります。基本をマスターしたら、より高度なユースケースに対応してルーターを カスタマイズ できます。

tRPC の初期化​

tRPC はアプリケーションごとに 1 回だけ初期化する必要があります。tRPC のインスタンスが複数あると問題が発生します。

server/trpc.ts
ts
import { initTRPC } from '@trpc/server';
 
// You can use any variable name you like.
// We use t to keep things simple.
const t = initTRPC.create();
 
export const router = t.router;
export const publicProcedure = t.procedure;
server/trpc.ts
ts
import { initTRPC } from '@trpc/server';
 
// You can use any variable name you like.
// We use t to keep things simple.
const t = initTRPC.create();
 
export const router = t.router;
export const publicProcedure = t.procedure;

ここで t 自体ではなく、t 変数の特定のメソッドをエクスポートしていることがわかります。これにより、コードベースで慣用的に使用する特定のプロシージャのセットを確立できます。

ルーターの定義​

次に、アプリケーションで使用するプロシージャを使用してルーターを定義しましょう。これで、API の「エンドポイント」が作成されました。

これらのエンドポイントがフロントエンドに公開されるようにするには、アダプター を appRouter インスタンスで構成する必要があります。

server/_app.ts
ts
import { publicProcedure, router } from './trpc';
 
const appRouter = router({
  greeting: publicProcedure.query(() => 'hello tRPC v10!'),
});
 
// Export only the type of a router!
// This prevents us from importing server code on the client.
export type AppRouter = typeof appRouter;
server/_app.ts
ts
import { publicProcedure, router } from './trpc';
 
const appRouter = router({
  greeting: publicProcedure.query(() => 'hello tRPC v10!'),
});
 
// Export only the type of a router!
// This prevents us from importing server code on the client.
export type AppRouter = typeof appRouter;

高度な使用法​

ルーターを初期化すると、tRPC で次のようなことができます。

メソッドチェーンを使用して、初期化時に t オブジェクトをカスタマイズできます。次のように

ts
const t = initTRPC.context<Context>().meta<Meta>().create({
  /* [...] */
});
ts
const t = initTRPC.context<Context>().meta<Meta>().create({
  /* [...] */
});

ランタイム構成​

ts
export interface RootConfig<TTypes extends RootTypes> {
  /**
   * Use a data transformer
   * @link https://trpc.dokyumento.jp/docs/v11/data-transformers
   */
  transformer: TTypes['transformer'];
  /**
   * Use custom error formatting
   * @link https://trpc.dokyumento.jp/docs/v11/error-formatting
   */
  errorFormatter: ErrorFormatter<TTypes['ctx'], any>;
  /**
   * Allow `@trpc/server` to run in non-server environments
   * @warning **Use with caution**, this should likely mainly be used within testing.
   * @default false
   */
  allowOutsideOfServer: boolean;
  /**
   * Is this a server environment?
   * @warning **Use with caution**, this should likely mainly be used within testing.
   * @default typeof window === 'undefined' || 'Deno' in window || process.env.NODE_ENV === 'test'
   */
  isServer: boolean;
  /**
   * Is this development?
   * Will be used to decide if the API should return stack traces
   * @default process.env.NODE_ENV !== 'production'
   */
  isDev: boolean;
}
ts
export interface RootConfig<TTypes extends RootTypes> {
  /**
   * Use a data transformer
   * @link https://trpc.dokyumento.jp/docs/v11/data-transformers
   */
  transformer: TTypes['transformer'];
  /**
   * Use custom error formatting
   * @link https://trpc.dokyumento.jp/docs/v11/error-formatting
   */
  errorFormatter: ErrorFormatter<TTypes['ctx'], any>;
  /**
   * Allow `@trpc/server` to run in non-server environments
   * @warning **Use with caution**, this should likely mainly be used within testing.
   * @default false
   */
  allowOutsideOfServer: boolean;
  /**
   * Is this a server environment?
   * @warning **Use with caution**, this should likely mainly be used within testing.
   * @default typeof window === 'undefined' || 'Deno' in window || process.env.NODE_ENV === 'test'
   */
  isServer: boolean;
  /**
   * Is this development?
   * Will be used to decide if the API should return stack traces
   * @default process.env.NODE_ENV !== 'production'
   */
  isDev: boolean;
}