useCsRqAdvancedQueryButtonClickEvent

useCsRqAdvancedQueryButtonClickEvent は、API 呼び出し方式 Orval（拡張版）に対応する参照系 API ボタンイベントを初期化するためのフックです。 このイベントはボタンクリック時に検索を行うことを想定したクリックイベントです。 クリック時のみ検索をさせたい場合は、TanStack QueryのuseQueryの第2引数でenabledをfalseにして実行してください。

シグネチャ

useCsRqAdvancedQueryButtonClickEvent
 <TApiResponse>
(queryResult: RqAdvancedQueryResult
 <TApiResponse>):
CsQueryButtonClickEvent
 <TApiResponse>

引数

引数名	必須	型	説明
queryResult	〇	RqAdvancedQueryResult<TApiResponse>*¹	TanStack Query の useQuery を使ったカスタムフックを指定します。

*1：RqAdvancedQueryResultは APIのレスポンスに関する情報を保持する型定義です。

返り値

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

使用例

export const useTodoSearchView = (): TodoSearchView => {
  const keyword = useCsInputTextItem("検索キーワード", useInit(""), stringRule(true)),

  return useCsView(
    {
      keyword: keyword,
      searchButton: useCsRqAdvancedQueryButtonClickEvent(useSearchTodo({keyword: keyword.value ?? ""}, 
        query: {
          enabled: false, // ボタンをクリックしたときのみ検索させるためenabledをfalseにする
          refetchOnWindowFocus: false,
        },)),
    },
  );
};