@connectrpc/connect-query/dist/esm/use-query.js

TypeScript-first expansion pack for TanStack Query that gives you Protobuf superpowers.

// 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 { createQueryOptions } from "@connectrpc/connect-query-core";
import { useQuery as tsUseQuery, useSuspenseQuery as tsUseSuspenseQuery, } from "@tanstack/react-query";
import { useTransport } from "./use-transport.js";
/**
 * Query the method provided. Maps to useQuery on tanstack/react-query
 */
export function useQuery(schema, input, { transport, ...queryOptions } = {}) {
    const transportFromCtx = useTransport();
    const baseOptions = createQueryOptions(schema, input, {
        transport: transport ?? transportFromCtx,
    });
    return tsUseQuery({
        ...baseOptions,
        ...queryOptions,
    });
}
/**
 * Query the method provided. Maps to useSuspenseQuery on tanstack/react-query
 */
export function useSuspenseQuery(schema, input, { transport, headers, ...queryOptions } = {}) {
    const transportFromCtx = useTransport();
    const baseOptions = createQueryOptions(schema, input, {
        transport: transport ?? transportFromCtx,
        headers,
    });
    return tsUseSuspenseQuery({
        ...baseOptions,
        ...queryOptions,
    });
}