@connectrpc/connect-query/dist/esm/connect-query-key.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 { toPlainMessage, } from "@bufbuild/protobuf";
import { disableQuery } from "./utils.js";
/**
 * TanStack Query requires query keys in order to decide when the query should automatically update.
 *
 * In Connect-Query, much of this is handled automatically by this function.
 *
 * @see ConnectQueryKey for information on the components of Connect-Query's keys.
 */
export function createConnectQueryKey(methodDescriptor, input) {
    return [
        methodDescriptor.service.typeName,
        methodDescriptor.name,
        toPlainMessage(new methodDescriptor.I(input === disableQuery || !input ? {} : input)),
    ];
}
/**
 * Similar to @see createConnectQueryKey, but for infinite queries.
 */
export function createConnectInfiniteQueryKey(methodDescriptor, input) {
    return [...createConnectQueryKey(methodDescriptor, input), "infinite"];
}
//# sourceMappingURL=connect-query-key.js.map