@connectrpc/connect-query
Version:
TypeScript-first expansion pack for TanStack Query that gives you Protobuf superpowers.
59 lines • 2.19 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 { useQuery as tsUseQuery, useSuspenseQuery as tsUseSuspenseQuery, } from "@tanstack/react-query";
import { createUseQueryOptions } from "./create-use-query-options.js";
import { useTransport } from "./use-transport.js";
/**
* Query the method provided. Maps to useQuery on tanstack/react-query
*
* @param methodSig
* @returns
*/
export function useQuery(methodSig, input, { transport, callOptions, ...queryOptions } = {}) {
const transportFromCtx = useTransport();
const baseOptions = createUseQueryOptions(methodSig, input, {
transport: transport ?? transportFromCtx,
callOptions,
});
const { enabled: baseEnabled, ...baseRest } = baseOptions;
const tsOpts = {
...queryOptions,
...baseRest,
};
// The query cannot be enabled if the base options are disabled, regardless of
// incoming query options.
const enabled = baseEnabled ?? queryOptions.enabled;
if (enabled !== undefined) {
tsOpts.enabled = enabled;
}
return tsUseQuery(tsOpts);
}
/**
* Query the method provided. Maps to useSuspenseQuery on tanstack/react-query
*
* @param methodSig
* @returns
*/
export function useSuspenseQuery(methodSig, input, { transport, callOptions, ...queryOptions } = {}) {
const transportFromCtx = useTransport();
const baseOptions = createUseQueryOptions(methodSig, input, {
transport: transport ?? transportFromCtx,
callOptions,
});
return tsUseSuspenseQuery({
...queryOptions,
...baseOptions,
});
}
//# sourceMappingURL=use-query.js.map