synapse-react-client
Version:
[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie
14 lines • 1.33 kB
TypeScript
import { SynapseClientError } from '@sage-bionetworks/synapse-client';
import { AsynchronousJobStatus, QueryBundleRequest, QueryResultBundle } from '@sage-bionetworks/synapse-types';
import { UseQueryOptions, UseSuspenseQueryOptions } from '@tanstack/react-query';
/**
* Get the metadata (columns, count, i.e. not row data) for the query in the current QueryContext (provided by
* QueryWrapper)
*/
export declare function useGetQueryMetadata<TSelect = Omit<QueryResultBundle, 'queryResult'>>(optionsOverrides?: Partial<UseQueryOptions<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, SynapseClientError, TSelect>>): import("@tanstack/react-query").UseQueryResult<import("@tanstack/query-core").NoInfer<TSelect>, SynapseClientError>;
/**
* Get the metadata (columns, count, i.e. not row data) for the query in the current QueryContext (provided by
* QueryWrapper). Suspends the component tree if the query data is not yet loaded.
*/
export declare function useSuspenseGetQueryMetadata<TSelect = Omit<QueryResultBundle, 'queryResult'>>(optionsOverrides?: Partial<UseSuspenseQueryOptions<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, SynapseClientError, TSelect>>): import("@tanstack/react-query").UseSuspenseQueryResult<TSelect, SynapseClientError>;
//# sourceMappingURL=useGetQueryMetadata.d.ts.map