Skip to main content

useCsRqMutateButtonClickEvent

useCsRqMutateButtonClickEvent は、API 呼び出し方式が TanStack Query および Orval（シンプル版）に対応する更新系 API ボタンイベントを初期化するためのフックです。

シグネチャ​

useCsRqMutateButtonClickEvent
 <TApiRequest, TApiResponse, TApiError, TContext = unknown>
(mutationResult: UseMutationResult
 <TApiResponse, TApiError, TApiRequest, TContext>):
CsMutateButtonClickEvent
 <TApiRequest, TApiResponse, TApiError, TContext>

引数​

引数名必須型説明
mutationResult〇UseMutationResult<TApiResponse, TApiError, TApiRequest, TContext>*¹TanStack Query の useMutate を使ったカスタムフックを指定します。

*1：UseMutationResultは API のリクエスト、レスポンス、エラー、コンテキストに関する情報を保持するTanStack Queryの組み込みの型定義です。

返り値​

API のリクエストやレスポンス、成功・失敗のステータスなどの情報が含まれるCsMutateButtonClickEventクラスのインスタンスを返します。

使用例​

export const useTodoPostView = (): TodoPostView => {
  return useCsView(
    {
      title: useCsInputTextItem(
        "タイトル",
        useInit(""),
        stringRule(false, 1, 10)
      ),
      description: useCsTextAreaItem("説明", useInit(""), stringRule(false)),
      createButton: useCsRqMutateButtonClickEvent(usePostTodo()),
    },
    {
      validationTrigger: "onBlur", // カーソルが離れたタイミングでバリデーションを実行
    }
  );
};