Mathis
98477c5f27
- Renamed `is_mail_verified` to `is_email_verified` in `IDbUser` - Replaced `username` with `email` in `IReqLogin` - Commented out `dob` in `IReqRegister` - Added new field `_questionMarksFields` in `IDbFactorize` Issue: #18 Signed-off-by: Mathis <yidhra@tuta.io>
55 lines
1.3 KiB
TypeScript
55 lines
1.3 KiB
TypeScript
/**
|
|
* Represents the output of the factorization function.
|
|
*/
|
|
export interface IDbFactorizeOutput {
|
|
/**
|
|
* Description: The variable `_valuesArray` is an array that can contain values of type `string`, `boolean`, `number`, or `Date`.
|
|
* (The value associated with the keys of `_keysTemplate`)
|
|
*
|
|
* @type {Array<string | boolean | number | Date>}
|
|
*/
|
|
_valuesArray: Array<string | boolean | number | Date>;
|
|
/**
|
|
* Represents the SQL Query template for the keys.
|
|
* @type {string}
|
|
*/
|
|
_keysTemplate: string;
|
|
|
|
/**
|
|
* The list of ? for the "VALUE" section
|
|
*/
|
|
_questionMarksFields: string;
|
|
|
|
/**
|
|
* The total number of fields.
|
|
*
|
|
* @type {number}
|
|
*/
|
|
totalFields: number;
|
|
}
|
|
|
|
/**
|
|
* Interface IDbFactorizeInput represents the input required to factorize a SQL query.
|
|
*/
|
|
export interface IDbFactorizeInput {
|
|
/**
|
|
* An object containing values that will be in a SQL Query.
|
|
*
|
|
* @type {Array<string | boolean | number | Date>}
|
|
*/
|
|
values: object;
|
|
/**
|
|
* Represents the name of the action that will result of the prepared SQL Query.
|
|
*
|
|
* @type {string}
|
|
*/
|
|
actionName: string;
|
|
/**
|
|
* Indicates whether an error should be thrown when encountering an error.
|
|
* If set to true, an error will be thrown. If set to false or not provided, the error will not be thrown.
|
|
*
|
|
* @type {boolean}
|
|
*/
|
|
throwOnError?: true;
|
|
}
|