Skip to main content

useCsRqAdvancedQueryLoadEvent

useCsRqAdvancedQueryLoadEvent は、API 呼び出し方式が Orval(拡張版)に対応する参照系 API ロードイベントを初期化するためのフックです。

シグネチャ

useCsRqAdvancedQueryLoadEvent
 <TApiResponse>
(queryResult: RqAdvancedQueryResult
 <TApiResponse>):
CsRqAdvancedQueryLoadEvent
 <TApiResponse>

引数

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

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

返り値

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

使用例

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

return useCsView(
{
keyword: keyword,
loadEvent: useCsRqAdvancedQueryLoadEvent(useSearchTodo({ keyword: keyword.value ?? "" } )),
}
);
};