angular-odata/lib/resources/query/options.d.ts

Client side OData typescript library for Angular

import { Parser, ParserOptions, QueryOption } from '../../types';
import { Expand, Filter, OrderBy, Select, Transform } from './builder';
import { ComputeExpression, Expression, FilterExpression, OrderByExpression, SearchExpression } from './expressions';
import { ApplyExpression } from './expressions/apply';
import { ExpandExpression } from './expressions/expand';
import { SelectExpression } from './expressions/select';
import { ODataQueryOptionHandler } from './handlers';
export type ODataQueryArguments<T> = {
    [QueryOption.select]?: Select<T> | SelectExpression<T> | null;
    [QueryOption.expand]?: Expand<T> | ExpandExpression<T> | null;
    [QueryOption.compute]?: string | ComputeExpression<T> | null;
    [QueryOption.apply]?: string | ApplyExpression<T> | null;
    [QueryOption.filter]?: Filter<T> | FilterExpression<T> | null;
    [QueryOption.search]?: string | SearchExpression<T> | null;
    [QueryOption.transform]?: Transform<T> | null;
    [QueryOption.orderBy]?: OrderBy<T> | OrderByExpression<T> | null;
    [QueryOption.top]?: number | null;
    [QueryOption.skip]?: number | null;
    [QueryOption.skiptoken]?: string | null;
    [QueryOption.format]?: string | null;
    [QueryOption.levels]?: number | 'max' | null;
    [QueryOption.count]?: boolean | null;
};
export declare const pathAndParamsFromQueryOptions: <T>(values: Map<QueryOption, any>, { escape, parser, options, }?: {
    escape?: boolean;
    parser?: Parser<T>;
    options?: ParserOptions;
}) => [string, {
    [name: string]: any;
}];
export declare class ODataQueryOptions<T> {
    private _values;
    constructor(values?: Map<QueryOption, any>);
    pathAndParams({ escape, parser, options, }?: {
        escape?: boolean;
        parser?: Parser<T>;
        options?: ParserOptions;
    }): [string, {
        [name: string]: any;
    }];
    toString({ escape, parser, }?: {
        escape?: boolean;
        parser?: Parser<T>;
    }): string;
    toJson(): {};
    fromJson<T>(json: {
        [name: string]: any;
    }): this;
    static fromJson<T>(json: {
        [name: string]: any;
    }): ODataQueryOptions<T>;
    toQueryArguments(): ODataQueryArguments<T>;
    clone<O>(): ODataQueryOptions<O>;
    expression(key: QueryOption, exp?: Expression<T>): any;
    option<O>(key: QueryOption, opts?: O): ODataQueryOptionHandler<O>;
    has(key: QueryOption): boolean;
    remove(...keys: QueryOption[]): void;
    keep(...keys: QueryOption[]): void;
    clear(): void;
}