@decaf-ts/for-couchdb
Version:
template for ts projects
64 lines • 6.32 kB
JavaScript
/**
* @description Default query limit for CouchDB queries
* @summary Maximum number of documents to return in a single query
* @const CouchDBQueryLimit
* @memberOf module:for-couchdb
*/
export const CouchDBQueryLimit = 250;
/**
* @description Mapping of operator names to CouchDB Mango query operators
* @summary Constants for CouchDB comparison operators used in Mango queries
* @typedef {Object} CouchDBOperatorType
* @property {string} EQUAL - Equality operator ($eq)
* @property {string} DIFFERENT - Inequality operator ($ne)
* @property {string} BIGGER - Greater than operator ($gt)
* @property {string} BIGGER_EQ - Greater than or equal operator ($gte)
* @property {string} SMALLER - Less than operator ($lt)
* @property {string} SMALLER_EQ - Less than or equal operator ($lte)
* @property {string} NOT - Negation operator ($not)
* @property {string} IN - In array operator ($in)
* @property {string} REGEXP - Regular expression operator ($regex)
* @const CouchDBOperator
* @type {CouchDBOperatorType}
* @memberOf module:for-couchdb
*/
export const CouchDBOperator = {
EQUAL: "$eq",
DIFFERENT: "$ne",
BIGGER: "$gt",
BIGGER_EQ: "$gte",
SMALLER: "$lt",
SMALLER_EQ: "$lte",
// BETWEEN = "BETWEEN",
NOT: "$not",
IN: "$in",
// IS = "IS",
REGEXP: "$regex",
};
/**
* @description Mapping of logical operator names to CouchDB Mango query operators
* @summary Constants for CouchDB logical operators used in Mango queries
* @typedef {Object} CouchDBGroupOperatorType
* @property {string} AND - Logical AND operator ($and)
* @property {string} OR - Logical OR operator ($or)
* @const CouchDBGroupOperator
* @type {CouchDBGroupOperatorType}
* @memberOf module:for-couchdb
*/
export const CouchDBGroupOperator = {
AND: "$and",
OR: "$or",
};
/**
* @description Special constant values used in CouchDB queries
* @summary String constants representing special values in CouchDB
* @typedef {Object} CouchDBConstType
* @property {string} NULL - String representation of null value
* @const CouchDBConst
* @type {CouchDBConstType}
* @memberOf module:for-couchdb
*/
export const CouchDBConst = {
NULL: "null",
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3F1ZXJ5L2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQTs7Ozs7R0FLRztBQUNILE1BQU0sQ0FBQyxNQUFNLGlCQUFpQixHQUFHLEdBQUcsQ0FBQztBQUVyQzs7Ozs7Ozs7Ozs7Ozs7OztHQWdCRztBQUNILE1BQU0sQ0FBQyxNQUFNLGVBQWUsR0FBa0M7SUFDNUQsS0FBSyxFQUFFLEtBQUs7SUFDWixTQUFTLEVBQUUsS0FBSztJQUNoQixNQUFNLEVBQUUsS0FBSztJQUNiLFNBQVMsRUFBRSxNQUFNO0lBQ2pCLE9BQU8sRUFBRSxLQUFLO0lBQ2QsVUFBVSxFQUFFLE1BQU07SUFDbEIsdUJBQXVCO0lBQ3ZCLEdBQUcsRUFBRSxNQUFNO0lBQ1gsRUFBRSxFQUFFLEtBQUs7SUFDVCxhQUFhO0lBQ2IsTUFBTSxFQUFFLFFBQVE7Q0FDakIsQ0FBQztBQUVGOzs7Ozs7Ozs7R0FTRztBQUNILE1BQU0sQ0FBQyxNQUFNLG9CQUFvQixHQUFrQztJQUNqRSxHQUFHLEVBQUUsTUFBTTtJQUNYLEVBQUUsRUFBRSxLQUFLO0NBQ1YsQ0FBQztBQUVGOzs7Ozs7OztHQVFHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sWUFBWSxHQUEyQjtJQUNsRCxJQUFJLEVBQUUsTUFBTTtDQUNiLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBNYW5nb09wZXJhdG9yIH0gZnJvbSBcIi4uL3R5cGVzXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIERlZmF1bHQgcXVlcnkgbGltaXQgZm9yIENvdWNoREIgcXVlcmllc1xuICogQHN1bW1hcnkgTWF4aW11bSBudW1iZXIgb2YgZG9jdW1lbnRzIHRvIHJldHVybiBpbiBhIHNpbmdsZSBxdWVyeVxuICogQGNvbnN0IENvdWNoREJRdWVyeUxpbWl0XG4gKiBAbWVtYmVyT2YgbW9kdWxlOmZvci1jb3VjaGRiXG4gKi9cbmV4cG9ydCBjb25zdCBDb3VjaERCUXVlcnlMaW1pdCA9IDI1MDtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gTWFwcGluZyBvZiBvcGVyYXRvciBuYW1lcyB0byBDb3VjaERCIE1hbmdvIHF1ZXJ5IG9wZXJhdG9yc1xuICogQHN1bW1hcnkgQ29uc3RhbnRzIGZvciBDb3VjaERCIGNvbXBhcmlzb24gb3BlcmF0b3JzIHVzZWQgaW4gTWFuZ28gcXVlcmllc1xuICogQHR5cGVkZWYge09iamVjdH0gQ291Y2hEQk9wZXJhdG9yVHlwZVxuICogQHByb3BlcnR5IHtzdHJpbmd9IEVRVUFMIC0gRXF1YWxpdHkgb3BlcmF0b3IgKCRlcSlcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBESUZGRVJFTlQgLSBJbmVxdWFsaXR5IG9wZXJhdG9yICgkbmUpXG4gKiBAcHJvcGVydHkge3N0cmluZ30gQklHR0VSIC0gR3JlYXRlciB0aGFuIG9wZXJhdG9yICgkZ3QpXG4gKiBAcHJvcGVydHkge3N0cmluZ30gQklHR0VSX0VRIC0gR3JlYXRlciB0aGFuIG9yIGVxdWFsIG9wZXJhdG9yICgkZ3RlKVxuICogQHByb3BlcnR5IHtzdHJpbmd9IFNNQUxMRVIgLSBMZXNzIHRoYW4gb3BlcmF0b3IgKCRsdClcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBTTUFMTEVSX0VRIC0gTGVzcyB0aGFuIG9yIGVxdWFsIG9wZXJhdG9yICgkbHRlKVxuICogQHByb3BlcnR5IHtzdHJpbmd9IE5PVCAtIE5lZ2F0aW9uIG9wZXJhdG9yICgkbm90KVxuICogQHByb3BlcnR5IHtzdHJpbmd9IElOIC0gSW4gYXJyYXkgb3BlcmF0b3IgKCRpbilcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBSRUdFWFAgLSBSZWd1bGFyIGV4cHJlc3Npb24gb3BlcmF0b3IgKCRyZWdleClcbiAqIEBjb25zdCBDb3VjaERCT3BlcmF0b3JcbiAqIEB0eXBlIHtDb3VjaERCT3BlcmF0b3JUeXBlfVxuICogQG1lbWJlck9mIG1vZHVsZTpmb3ItY291Y2hkYlxuICovXG5leHBvcnQgY29uc3QgQ291Y2hEQk9wZXJhdG9yOiBSZWNvcmQ8c3RyaW5nLCBNYW5nb09wZXJhdG9yPiA9IHtcbiAgRVFVQUw6IFwiJGVxXCIsXG4gIERJRkZFUkVOVDogXCIkbmVcIixcbiAgQklHR0VSOiBcIiRndFwiLFxuICBCSUdHRVJfRVE6IFwiJGd0ZVwiLFxuICBTTUFMTEVSOiBcIiRsdFwiLFxuICBTTUFMTEVSX0VROiBcIiRsdGVcIixcbiAgLy8gQkVUV0VFTiA9IFwiQkVUV0VFTlwiLFxuICBOT1Q6IFwiJG5vdFwiLFxuICBJTjogXCIkaW5cIixcbiAgLy8gSVMgPSBcIklTXCIsXG4gIFJFR0VYUDogXCIkcmVnZXhcIixcbn07XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIE1hcHBpbmcgb2YgbG9naWNhbCBvcGVyYXRvciBuYW1lcyB0byBDb3VjaERCIE1hbmdvIHF1ZXJ5IG9wZXJhdG9yc1xuICogQHN1bW1hcnkgQ29uc3RhbnRzIGZvciBDb3VjaERCIGxvZ2ljYWwgb3BlcmF0b3JzIHVzZWQgaW4gTWFuZ28gcXVlcmllc1xuICogQHR5cGVkZWYge09iamVjdH0gQ291Y2hEQkdyb3VwT3BlcmF0b3JUeXBlXG4gKiBAcHJvcGVydHkge3N0cmluZ30gQU5EIC0gTG9naWNhbCBBTkQgb3BlcmF0b3IgKCRhbmQpXG4gKiBAcHJvcGVydHkge3N0cmluZ30gT1IgLSBMb2dpY2FsIE9SIG9wZXJhdG9yICgkb3IpXG4gKiBAY29uc3QgQ291Y2hEQkdyb3VwT3BlcmF0b3JcbiAqIEB0eXBlIHtDb3VjaERCR3JvdXBPcGVyYXRvclR5cGV9XG4gKiBAbWVtYmVyT2YgbW9kdWxlOmZvci1jb3VjaGRiXG4gKi9cbmV4cG9ydCBjb25zdCBDb3VjaERCR3JvdXBPcGVyYXRvcjogUmVjb3JkPHN0cmluZywgTWFuZ29PcGVyYXRvcj4gPSB7XG4gIEFORDogXCIkYW5kXCIsXG4gIE9SOiBcIiRvclwiLFxufTtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gU3BlY2lhbCBjb25zdGFudCB2YWx1ZXMgdXNlZCBpbiBDb3VjaERCIHF1ZXJpZXNcbiAqIEBzdW1tYXJ5IFN0cmluZyBjb25zdGFudHMgcmVwcmVzZW50aW5nIHNwZWNpYWwgdmFsdWVzIGluIENvdWNoREJcbiAqIEB0eXBlZGVmIHtPYmplY3R9IENvdWNoREJDb25zdFR5cGVcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBOVUxMIC0gU3RyaW5nIHJlcHJlc2VudGF0aW9uIG9mIG51bGwgdmFsdWVcbiAqIEBjb25zdCBDb3VjaERCQ29uc3RcbiAqIEB0eXBlIHtDb3VjaERCQ29uc3RUeXBlfVxuICogQG1lbWJlck9mIG1vZHVsZTpmb3ItY291Y2hkYlxuICovXG5leHBvcnQgY29uc3QgQ291Y2hEQkNvbnN0OiBSZWNvcmQ8c3RyaW5nLCBzdHJpbmc+ID0ge1xuICBOVUxMOiBcIm51bGxcIixcbn07XG4iXX0=