UNPKG

951 BTypeScriptView Raw
1import { Constructable, Entity } from '../entity';
2import { Filterable } from '../filter';
3import { UriConverter } from '../uri-conversion';
4declare type GetFilterType<EntityT extends Entity> = (filter: Filterable<EntityT>, entityConstructor: Constructable<EntityT>) => Partial<{
5 filter: string;
6}>;
7/**
8 * Interface representing the return of the getFilter creator [[createGetFilter]].
9 */
10export interface GetFilter<EntityT extends Entity = any> {
11 getFilter: GetFilterType<EntityT>;
12}
13/**
14 * Creates a getFilter function using the OData v2 or OData v4 URI converter.
15 * The concrete filter getters are initiated in odata/v2/uri-conversion/odata-uri.ts and odata/v4/uri-conversion/odata-uri.ts.
16 * @param uriConverter - Uri converter for v2 or v4.
17 * @returns The filter getter. See interface [[GetFilter]]
18 */
19export declare function createGetFilter(uriConverter: UriConverter): GetFilter;
20export {};
21//# sourceMappingURL=get-filter.d.ts.map
\No newline at end of file