tspace-mysql 1.8.2 → 1.8.4

package/build/lib/core/Builder.d.ts

@@ -1,6 +1,7 @@
-import { AbstractBuilder } from './Abstracts/AbstractBuilder';
-import { Join } from './Join';
-import { TPagination, TConnectionOptions, TConnection, TConnectionTransaction } from '../types';
+import { AbstractBuilder } from "./Abstracts/AbstractBuilder";
+import { Join } from "./Join";
+import { CONSTANTS } from "../constants";
+import { TPagination, TConnectionOptions, TConnection, TConnectionTransaction } from "../types";
 declare class Builder extends AbstractBuilder {
     constructor();
     /**
@@ -145,7 +146,7 @@ declare class Builder extends AbstractBuilder {
      * @param {string} type - The types 'object' | 'array'
      * @returns {this} this
      */
-    returnType(type: 'object' | 'array'): this;
+    returnType(type: "object" | "array"): this;
     /**
      * The 'pluck' method is used to retrieve the value of a single column from the first result of a query.
      *
@@ -394,7 +395,9 @@ declare class Builder extends AbstractBuilder {
      * @param {string} subQuery
      * @returns {this}
      */
-    whereSubQuery(column: string, subQuery: string): this;
+    whereSubQuery(column: string, subQuery: string, options?: {
+        operator?: typeof CONSTANTS['EQ'] | typeof CONSTANTS['IN'];
+    }): this;
     /**
      * The 'whereNotSubQuery' method is used to add a conditional clause to a database query that involves a subquery.
      *
@@ -405,7 +408,9 @@ declare class Builder extends AbstractBuilder {
      * @param {string} subQuery
      * @returns {this}
      */
-    whereNotSubQuery(column: string, subQuery: string): this;
+    whereNotSubQuery(column: string, subQuery: string, options?: {
+        operator?: typeof CONSTANTS['NOT_EQ'] | typeof CONSTANTS['NOT_IN'];
+    }): this;
     /**
      * The 'orWhereSubQuery' method is used to add a conditional clause to a database query that involves a subquery.
      *
@@ -416,7 +421,9 @@ declare class Builder extends AbstractBuilder {
      * @param {string} subQuery
      * @returns {this}
      */
-    orWhereSubQuery(column: string, subQuery: string): this;
+    orWhereSubQuery(column: string, subQuery: string, options?: {
+        operator?: typeof CONSTANTS['EQ'] | typeof CONSTANTS['IN'];
+    }): this;
     /**
      * The 'orWhereNotSubQuery' method is used to add a conditional clause to a database query that involves a subquery.
      *
@@ -427,7 +434,9 @@ declare class Builder extends AbstractBuilder {
      * @param {string} subQuery
      * @returns {this}
      */
-    orWhereNotSubQuery(column: string, subQuery: string): this;
+    orWhereNotSubQuery(column: string, subQuery: string, options?: {
+        operator?: typeof CONSTANTS['NOT_EQ'] | typeof CONSTANTS['NOT_IN'];
+    }): this;
     /**
      * The 'whereBetween' method is used to add a conditional clause to a database query that checks if a specified column's value falls within a specified range of values.
      *
@@ -685,7 +694,7 @@ declare class Builder extends AbstractBuilder {
      * .get()
      * @returns {this}
      */
-    joinSubQuery({ localKey, foreignKey, sql }: {
+    joinSubQuery({ localKey, foreignKey, sql, }: {
         localKey: string;
         foreignKey: string;
         sql: string;
@@ -698,7 +707,7 @@ declare class Builder extends AbstractBuilder {
      * @param {string?} order by default order = 'asc' but you can used 'asc' or  'desc'
      * @returns {this}
      */
-    orderBy(column: string, order?: 'ASC' | 'asc' | 'DESC' | 'desc'): this;
+    orderBy(column: string, order?: "ASC" | "asc" | "DESC" | "desc"): this;
     /**
      * The 'orderByRaw' method is used to specify the order in which the results of a database query should be sorted.
      *
@@ -709,7 +718,7 @@ declare class Builder extends AbstractBuilder {
      * @param {string?} order [order=asc] asc, desc
      * @returns {this}
      */
-    orderByRaw(column: string, order?: 'ASC' | 'asc' | 'DESC' | 'desc'): this;
+    orderByRaw(column: string, order?: "ASC" | "asc" | "DESC" | "desc"): this;
     /**
      * The 'random' method is used to retrieve random records from a database table or to randomize the order in which records are returned in the query result set.
      *
@@ -1027,7 +1036,7 @@ declare class Builder extends AbstractBuilder {
      *
      * This method is particularly useful for debugging and understanding the SQL queries generated by your application.
      * @returns {string}
-    */
+     */
     toRawSQL(): string;
     /**
      * The 'getTableName' method is used to get table name
@@ -1066,13 +1075,13 @@ declare class Builder extends AbstractBuilder {
      * The 'hook' method is used function when execute returns a result to callback function
      * @param {Function} func function for callback result
      * @returns {this}
-    */
+     */
     hook(func: Function): this;
     /**
      * The 'before' method is used function when execute returns a result to callback function
      * @param {Function} func function for callback result
      * @returns {this}
-    */
+     */
     before(func: Function): this;
     /**
      *
@@ -1338,20 +1347,20 @@ declare class Builder extends AbstractBuilder {
      */
     getGroupBy(column: string): Promise<Map<string | number, any[]>>;
     /**
-    * The 'findGroupBy' method is used to execute a database query and retrieve the result set that matches the query conditions.
-    *
-    * It retrieves multiple records from a database table based on the criteria specified in the query.
-    *
-    * It returns record to new Map
-    * @param {string} column
-    * @example
-    *  const results = await new DB('posts')
-    * .findGroupBy('user_id')
-    *
-    *  // you can find with user id in the results
-    *  const postsByUserId1 = results.get(1)
-    * @returns {promise<Array>}
-    */
+     * The 'findGroupBy' method is used to execute a database query and retrieve the result set that matches the query conditions.
+     *
+     * It retrieves multiple records from a database table based on the criteria specified in the query.
+     *
+     * It returns record to new Map
+     * @param {string} column
+     * @example
+     *  const results = await new DB('posts')
+     * .findGroupBy('user_id')
+     *
+     *  // you can find with user id in the results
+     *  const postsByUserId1 = results.get(1)
+     * @returns {promise<Array>}
+     */
     findGroupBy(column: string): Promise<Map<string | number, any[]>>;
     /**
      * The 'save' method is used to persist a new 'Model' or new 'DB' instance or update an existing model instance in the database.
@@ -1444,7 +1453,7 @@ declare class Builder extends AbstractBuilder {
      * @property {boolean} option.force
      * @returns {promise<boolean>}
      */
-    truncate({ force }?: {
+    truncate({ force, }?: {
         force?: boolean;
     }): Promise<boolean>;
     /**
@@ -1493,7 +1502,7 @@ declare class Builder extends AbstractBuilder {
     protected _resultHandlerExists(data: any): any;
     whereReference(tableAndLocalKey: string, tableAndForeignKey?: string): this;
     protected _queryStatement(sql: string): Promise<any[]>;
-    protected _actionStatement({ sql, returnId }: {
+    protected _actionStatement({ sql, returnId, }: {
         sql: string;
         returnId?: boolean;
     }): Promise<any>;