@odata/parser/lib/builder/param.d.ts

OData(V4) Parser

import { ODataVersion } from './types';
export interface ODataParamOrderField {
    /**
     * field name
     */
    field: string;
    /**
     * order asc or desc
     */
    order?: 'asc' | 'desc';
}
/**
 * OData Query Param
 *
 * OData V4 support
 */
export declare class ODataQueryParam {
    static New(): ODataQueryParam;
    private $skip;
    private $filter;
    private $top;
    private $select;
    private $orderby;
    private $format;
    private $search;
    private $expand;
    private $count;
    /**
     *
     * count items in odata v4
     *
     * @param count
     *
     * @version 4.0.0
     */
    count(count?: boolean): ODataQueryParam;
    /**
     * apply filter for query
     *
     * @param filter
     */
    filter(filter?: any): this;
    /**
     * skip first records
     *
     * @param skip
     */
    skip(skip: number): this;
    /**
     * limit result max records
     *
     * @param top
     */
    top(top: number): this;
    /**
     * select viewed fields
     *
     * @param selects
     */
    select(selects: string | string[]): this;
    /**
     * set order sequence
     *
     * @param fieldOrOrders
     * @param order default desc, disabled when first params is array
     */
    orderby(fieldOrOrders: string | ODataParamOrderField[], order?: 'asc' | 'desc'): this;
    /**
     * set order by multi field
     *
     * @param fields
     */
    orderbyMulti(fields?: ODataParamOrderField[]): this;
    /**
     * result format, please keep it as json
     *
     * @param format default json
     */
    format(format: 'json' | 'xml'): this;
    /**
     * full text search
     *
     * default with fuzzy search, SAP system or OData V4 only
     *
     * @param value
     * @version 4.0.0
     */
    search(value: string): this;
    /**
     * expand navigation props
     *
     * @param fields
     * @param replace
     */
    expand(fields: string | string[], replace?: boolean): this;
    toString(version?: ODataVersion): string;
}
export declare const ODataParam: typeof ODataQueryParam;