ts-db-helper/src/core/models/queries/clause-group.model.d.ts

Simple ORM based on TypeScript

import { CompositeClause } from './composite-clause.model';
import { QueryPart } from './query-part.model';
import { Clause } from './clause.model';
import { IClause } from '../interfaces/i-clause.interface';
/**
 * @public
 * @class ClauseGroup
 *
 * @description
 * is a group of clause computed at the same
 * level. Clause group are used for where statement of Select, Update
 * and Delete statement.
 *
 * @example
 * ```typescript
 * // Create a group of clauses
 * const group = new ClauseGroup();
 *
 * // create clause to get Todo item where isDone === false
 * const doneClause = new Clause();
 * doneClause.key = 'isDone';
 * doneClause.value = false;
 * group.add(doneClause);
 *
 * // create clause to get Todo item where dueDate <= now
 * const dueDateClause = new Clause();
 * dueDateClause.key = 'dueDate';
 * dueDateClause.value = (new Date()).getTime();
 * dueDateClause.comparator = Clause.COMPARATORS.LTE;
 * group.add(dueDateClause);
 *
 * // start select clause
 * Select(Todo).where(group).exec().subscribe((QueryResult<Todo>) => {
 *      // do something with the result...
 * }, (err) => {
 *      // do something with the error...
 * });
 * ```
 *
 * @author  Olivier Margarit
 *
 * @since   0.1
 */
export declare class ClauseGroup {
    /**
     * @private
     * @property {Array<IClause>} clauses array of clause to append in the same group
     */
    private clauses;
    /**
     * @public
     * @constructor could take same parameters as add
     *
     * @param {ClauseGroup|Clause|Clause[]|CompositeClause|{[index: string]: any}} clauses clauses to add to the group
     */
    constructor(clauses?: ClauseGroup | Clause | Clause[] | CompositeClause | {
        [index: string]: any;
    });
    /**
     * @public
     * @method isEmpty check if clause group is empty
     *
     * @return {boolean} true if is empty
     */
    isEmpty(): boolean;
    /**
     * @public
     * @method add add one or many clause
     *
     * @example
     * // create group
     * const group = new ClauseGroup();
     *
     * // clause with dict notation
     * group.add({isDone: false, bar: 'foo'});
     *
     * // Adding a clause object
     * const clause = new Clause();
     * clause.key = 'isDone';
     * clause.value = false;
     * group.add(clause);
     *
     * @param {ClauseGroup|Clause|Clause[]|IClause[]|CompositeClause|{[index: string]: any}} clauses clauses to add to the clause group
     */
    add(clauses: ClauseGroup | Clause | Clause[] | IClause[] | CompositeClause | {
        [index: string]: any;
    }): void;
    /**
     * @public
     * @method build is apart of private API, should move later...
     * it build the clause  group to the string part of the query
     *
     * @return {QueryPart} of the query with the string part and
     *          clauses params.
     */
    build(): QueryPart;
}