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

call

エンジンの HTTP API 経由で MOD サービスの RPC メソッドを呼び出します。ブラウザ(WebView)と Node.js の両方の環境で動作します。

シグネチャ

rpc.call<T = unknown>(options: RpcCallOptions): Promise<T>

パラメータ

パラメータ説明
options.modNamestringターゲット MOD の名前
options.methodstring呼び出す RPC メソッド名
options.bodyunknownメソッドハンドラーに渡すオプションのリクエストボディ

戻り値

Promise<T> — MOD メソッドハンドラーからのパース済み JSON レスポンス。

エラーレスポンス

エンジンプロキシが返す可能性のあるエラー:

ステータス条件
404ターゲット MOD にメソッドが見つからない
502MOD サービスに到達不能
503MOD が未登録(サービスが実行されていない)
504リクエストがタイムアウト

使用例

import { rpc } from "@hmcs/sdk/rpc";

// リクエストボディ付きで呼び出し
const result = await rpc.call<{ greeting: string }>({
modName: "voicevox",
method: "speak",
body: { text: "Hello!" },
});
console.log(result.greeting);

// ボディなしで呼び出し
const status = await rpc.call<{ running: boolean }>({
modName: "voicevox",
method: "status",
});