ts-db-helper
Version:
Simple ORM based on TypeScript
76 lines (75 loc) • 1.91 kB
TypeScript
/**
* @public
* @class ClauseComparators
*
* @description
* list of managed comparators. This class should be converted to an enum in a furture version
*
* @author Olivier Margarit
*
* @since 0.2
*/
export declare class ClauseComparators {
/**
* @public
* @constant {string} DIFF the not equal comparator "!="
*/
static DIFF: string;
/**
* @public
* @constant {string} LT the lower than comparator "<"
*/
static LT: string;
/**
* @public
* @constant {string} LTE the lower than or equals comparator "<="
*/
static LTE: string;
/**
* @public
* @constant {string} GT the greater than comparator ">"
*/
static GT: string;
/**
* @public
* @constant {string} GTE the greater than equal comparator ">="
*/
static GTE: string;
/**
* @public
* @constant {string} LIKE the like comparator "LIKE"
*/
static LIKE: string;
/**
* @public
* @constant {string} IN the in comparator "IN"
*/
static IN: string;
/**
* @public
* @default
* @constant {string} EQ the equal comparator "="
*/
static EQ: string;
/**
* @public
* @static
* @method isKeyOf check if string is a valid key of ClauseComparator, this check
* is not case sensitive
*
* @param {string} val the value to check
*
* @return {boolean} is true if key will return a valid value with {@link ClauseComparator.valueOf}
*/
static isKeyOf(val: string): boolean;
/**
* @public
* @static
* @method valueOf get value of ClauseComparator by using a valid key val.
*
* @param {string} val the value key
*
* @return {boolean} the comparator linked to the key
*/
static valueOf(val: string): string;
}