メインコンテンツまでスキップ

型定義

RpcMethodDef<I, O>

rpc.method() で作成される型付き RPC メソッド定義です。

フィールド必須説明
descriptionstringいいえ人間が読める説明
timeoutnumberいいえタイムアウト(ミリ秒単位)
inputZodType<I>いいえ入力バリデーション用の Zod スキーマ
handler(params: I) => Promise<O>はいリクエストハンドラー

RpcHandlerFn<O>

(params: unknown) => Promise<O>

RPC メソッドハンドラーとして使用できるプレーンな非同期関数です。パースされた生の JSON ボディがバリデーションなしで直接渡されます。

RpcMethodEntry

RpcMethodDef | RpcHandlerFn

rpc.serve() で受け入れられるユニオン型です。同じ methods マップ内で rpc.method() による定義とプレーン関数を混在させることができます。

RpcServeOptions

フィールド説明
methodsRecord<string, RpcMethodEntry>メソッド名から定義へのマップ

RpcServer

rpc.serve() の戻り値です。

フィールド説明
portnumberサーバーが待ち受けているポート
close() => Promise<void>サーバーをグレースフルにシャットダウンします

RpcCallOptions

rpc.call() のオプションです。

フィールド必須説明
modNamestringはいターゲット MOD の名前
methodstringはい呼び出す RPC メソッド名
bodyunknownいいえメソッドハンドラーに渡すオプションのリクエストボディ