@konnec/vue-eloquent/dist/src/api/ApiQuery.d.ts

An interface for Vue and Laravel Eloquent through API

import { Query } from '../collection/IQuery';
import { IQueryPage, QueryPage } from '../collection/IQueryPage';
export default abstract class ApiQuery {
    /**
     * Filters used on GET request
     */
    protected filter: any;
    /**
     * Relations used on GET request
     */
    protected include: string[];
    /**
     * Attributes used on GET request
     */
    protected attributes: string[];
    /**
     * Fields to requested through API
     */
    protected fieldsSelection: string[];
    /**
     * Pagination used on GET request
     */
    protected paging: QueryPage;
    /**
     * Sorting used on GET request
     */
    protected sorting: string[];
    protected constructor();
    /**
     * Add a where clause to the query
     *
     * @param {object} filter - The filter to apply to the query
     * @return { this }
     */
    static where(filter: any): this;
    /**
     * Add relationships to the query
     *
     * @param {string[]} relationships - The relationships to include in the query
     * @returns {this} The query instance
     */
    static with(relationships: string[]): this;
    /**
     * Add attributes to the query
     *
     * @param {string[]} attributes - The attributes to append to the query
     * @returns {this} The query instance
     */
    static append(attributes: string[]): this;
    /**
     * Select specific fields to be returned by the query
     *
     * @param {string[]} fields - The fields to select
     * @returns {this} The query instance
     */
    static select(fields: string[]): this;
    /**
     * Sort the results of the query
     *
     * @param {string[]} sorting - The sorting criteria
     * @returns {this} The query instance
     */
    static sort(sorting: string[]): this;
    /**
     * Set the pagination options for the query
     *
     * @param {object} paging - The pagination options
     * @returns {this} The query instance
     */
    static paginate(paging: IQueryPage): this;
    /**
     * Add a where clause to the query
     *
     * @param {object} filter - The filter to apply to the query
     * @returns {this} The query instance
     */
    where(filter: any): this;
    /**
     * Add relationships to the query
     *
     * @param {string[]} relationships - The relationships to include in the query
     * @returns {this} The query instance
     */
    with(relationships: string[]): this;
    /**
     * Add attributes to the query
     *
     * @param {string[]} attributes - The attributes to append to the query
     * @returns {this} The query instance
     */
    append(attributes: string[]): this;
    /**
     * Select specific fields to be returned by the query
     *
     * @param {string[]} fields - The fields to select
     * @returns {this} The query instance
     */
    select(fields: string[]): this;
    /**
     * Sort the results of the query
     *
     * @param {string[]} sorting - The sorting criteria
     * @returns {this} The query instance
     */
    sort(sorting: string[]): this;
    /**
     * Set the pagination options for the query
     *
     * @param {object} paging - The pagination options
     * @returns {this} The query instance
     */
    paginate(paging: IQueryPage): this;
    /**
     * Get the query parameters as a query string
     *
     * @returns {object} The query parameters
     */
    protected queryString(): Query;
}