synapse-react-client
Version:
[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie
14 lines • 1.11 kB
TypeScript
import { Query, QueryBundleRequest, QueryResultBundle } from '@sage-bionetworks/synapse-types';
/**
* Fetch a registered QueryResultBundle that matches the given query.
* The results may be modified based on the limit and offset fields of the query, and the partMask of the request.
* @param queryBundleRequest
*/
export declare function getTableQueryResult(queryBundleRequest: QueryBundleRequest): QueryResultBundle;
/**
* Register a query and its result with the mock service. When this specific query is sent in a QueryBundleRequest, the given response will be returned.
* @param query - the query used to match to the response. Note: the limit and offset fields of a query are ignored when matching to a response. Limit and offset functionality are implemented by the mock service.
* @param response - the QueryResultBundle to return when the given query is requested. The results may be modified based on the limit and offset fields of the query.
*/
export declare function registerTableQueryResult(query: Query, response: QueryResultBundle): void;
//# sourceMappingURL=tableQueryService.d.ts.map