All files / Contracts/JsonApiClient QueryBuilderInterface.ts

0% Statements 0/0
0% Branches 0/0
0% Functions 0/0
0% Lines 0/0

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48                                                                                               
/**
 * Copyright 2015-2018 info@neomerx.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
import { FieldParameterInterface } from './FieldParameterInterface';
import { FilterParameterInterface } from './FilterParameterInterface';
import { RelationshipName } from '../JsonApi/RelationshipName';
import { ResourceIdentity } from './../JsonApi/ResourceIdentity';
import { SortParameterInterface } from './SortParameterInterface';
 
export interface QueryBuilderInterface {
    onlyFields(...fields: FieldParameterInterface[]): QueryBuilderInterface;
 
    withFilters(...filters: FilterParameterInterface[]): QueryBuilderInterface;
 
    combineFiltersWithAnd(): QueryBuilderInterface;
 
    combineFiltersWithOr(): QueryBuilderInterface;
 
    withSorts(...sorts: SortParameterInterface[]): QueryBuilderInterface;
 
    withIncludes(...relationships: RelationshipName[]): QueryBuilderInterface;
 
    withPagination(offset: number, limit: number): QueryBuilderInterface;
 
    enableEncodeUri(): QueryBuilderInterface;
 
    disableEncodeUri(): QueryBuilderInterface;
 
    isUriEncodingEnabled(): boolean;
 
    read(index: ResourceIdentity, relationship?: RelationshipName): string;
 
    index(): string;
}