/** * @license * Copyright 2024 Google LLC * * 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 { ExecuteQueryOptions } from '../core/query/queryOptions'; import { DataConnectExtensionWithMaxAge } from '../network'; import { DataConnect } from './DataConnect'; import { OperationRef, QUERY_STR, DataConnectResult, SerializedRef } from './Reference'; /** * QueryRef object */ export interface QueryRef extends OperationRef { refType: typeof QUERY_STR; } /** @internal */ export type InternalQueryResult = QueryResult & Omit, 'extensions'> & { extensions?: { dataConnect?: DataConnectExtensionWithMaxAge[]; }; }; /** * Result of `executeQuery` */ export interface QueryResult extends DataConnectResult { ref: QueryRef; toJSON: () => SerializedRef; } /** * Promise returned from `executeQuery` */ export interface QueryPromise extends Promise> { } /** * Execute Query * @param queryRef query to execute. * @returns `QueryPromise` */ export declare function executeQuery(queryRef: QueryRef, options?: ExecuteQueryOptions): QueryPromise; /** * Execute Query * @param dcInstance Data Connect instance to use. * @param queryName Query to execute * @returns `QueryRef` */ export declare function queryRef(dcInstance: DataConnect, queryName: string): QueryRef; /** * Execute Query * @param dcInstance Data Connect instance to use. * @param queryName Query to execute * @param variables Variables to execute with * @returns `QueryRef` */ export declare function queryRef(dcInstance: DataConnect, queryName: string, variables: Variables): QueryRef; /** * Converts serialized ref to query ref * @param serializedRef ref to convert to `QueryRef` * @returns `QueryRef` */ export declare function toQueryRef(serializedRef: SerializedRef): QueryRef;