UNPKG

@decaf-ts/for-couchdb

Version:

decaf-ts couchdb wrappers

github.com/decaf-ts/for-couchdb

decaf-ts/for-couchdb

48 lines (47 loc) • 2.07 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
import { MangoOperator } from "../types.d.cts"; /** * @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 declare 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 declare const CouchDBOperator: Record<string, MangoOperator>; /** * @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 declare const CouchDBGroupOperator: Record<string, MangoOperator>; /** * @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 declare const CouchDBConst: Record<string, string>;