Libraries
    Preparing search index...

    Type Alias EndpointQueryHooks<TArgs, TData>

    EndpointQueryHooks: TArgs extends undefined
        ? {
            prefetch(queryClient: QueryClient): Promise<void>;
            queryKey(): readonly unknown[];
            useMutation(
                options?: MutationHookOptions<TData, void>,
            ): UseMutationResult<TData, WebError, void>;
            useQuery(
                options?: QueryHookOptions<TData>,
            ): UseQueryResult<TData, WebError>;
            useSuspenseQuery(
                options?: SuspenseQueryHookOptions<TData>,
            ): UseSuspenseQueryResult<TData, WebError>;
        }
        : {
            prefetch(queryClient: QueryClient, args: TArgs): Promise<void>;
            queryKey(args?: TArgs): readonly unknown[];
            useInfiniteQuery<TPageParam = unknown>(
                getArgs: (pageParam: TPageParam) => TArgs,
                options: InfiniteQueryHookOptions<TData, TPageParam>,
            ): UseInfiniteQueryResult<InfiniteData<TData, TPageParam>, WebError>;
            useMutation(
                options?: MutationHookOptions<TData, TArgs>,
            ): UseMutationResult<TData, WebError, TArgs>;
            useQuery(
                args?: TArgs,
                options?: QueryHookOptions<TData>,
            ): UseQueryResult<TData, WebError>;
            useSuspenseQuery(
                args?: TArgs,
                options?: SuspenseQueryHookOptions<TData>,
            ): UseSuspenseQueryResult<TData, WebError>;
        }

    The set of TanStack Query hooks and helpers exposed for each endpoint on the typed query client.

    When TArgs is undefined (endpoint requires no arguments), the hooks can be called without an arguments parameter.

    Type Parameters

    • TArgs

      The endpoint's call arguments type (EndpointCallArgs<E>).

    • TData

      The endpoint's success response type (EndpointResponse<E>).