@odata2ts/odata-query-builder
Version:
Allows for building type-safe OData queries with a fluent API
19 lines (18 loc) • 745 B
TypeScript
import { QueryObjectModel } from "@odata2ts/odata-query-objects";
import { ODataQueryBuilderConfig, ODataQueryBuilderV4 as ODataQueryBuilderV4Model } from "../ODataQueryBuilderModel";
/**
* Create an QueryBuilder by passing in a path and a query object.
*
* Example for a query on a entity collection:
* ODataQueryBuilder.create("people", qPerson)
* .select(...)
* .filter(qPerson.age.greaterThan(...))
* ...
* .build()
*
* @param path base path to
* @param qEntity the query object
* @param config optionally pass a configuration
* @returns a QueryBuilder
*/
export declare function createQueryBuilderV4<Q extends QueryObjectModel>(path: string, qEntity: Q, config?: ODataQueryBuilderConfig): ODataQueryBuilderV4Model<Q>;