@connectrpc/connect-query
Version:
TypeScript-first expansion pack for TanStack Query that gives you Protobuf superpowers.
48 lines (47 loc) • 1.94 kB
JavaScript
// Copyright 2021-2023 The Connect Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import { createInfiniteQueryOptions } from "@connectrpc/connect-query-core";
import { useInfiniteQuery as tsUseInfiniteQuery, useSuspenseInfiniteQuery as tsUseSuspenseInfiniteQuery, } from "@tanstack/react-query";
import { useTransport } from "./use-transport.js";
/**
* Query the method provided. Maps to useInfiniteQuery on tanstack/react-query
*/
export function useInfiniteQuery(schema, input, { transport, pageParamKey, getNextPageParam, ...queryOptions }) {
const transportFromCtx = useTransport();
const baseOptions = createInfiniteQueryOptions(schema, input, {
transport: transport ?? transportFromCtx,
getNextPageParam,
pageParamKey,
});
return tsUseInfiniteQuery({
...baseOptions,
...queryOptions,
});
}
/**
* Query the method provided. Maps to useSuspenseInfiniteQuery on tanstack/react-query
*/
export function useSuspenseInfiniteQuery(schema, input, { transport, pageParamKey, getNextPageParam, headers, ...queryOptions }) {
const transportFromCtx = useTransport();
const baseOptions = createInfiniteQueryOptions(schema, input, {
transport: transport ?? transportFromCtx,
getNextPageParam,
pageParamKey,
headers,
});
return tsUseSuspenseInfiniteQuery({
...baseOptions,
...queryOptions,
});
}