@decaf-ts/for-couchdb/lib/constants.cjs

template for ts projects

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.CouchDBKeys = exports.reservedAttributes = void 0;
/**
 * @description Regular expression to identify reserved attributes in CouchDB
 * @summary Matches any attribute that starts with an underscore
 * @const reservedAttributes
 * @memberOf module:for-couchdb
 */
exports.reservedAttributes = /^_.*$/g;
/**
 * @description Key constants used in CouchDB operations
 * @summary Collection of string constants for CouchDB document properties and operations
 * @typedef {Object} CouchDBKeysType
 * @property {string} SEPARATOR - Separator used for combining table name and ID
 * @property {string} ID - CouchDB document ID field
 * @property {string} REV - CouchDB document revision field
 * @property {string} DELETED - CouchDB deleted document marker
 * @property {string} TABLE - Table name marker
 * @property {string} SEQUENCE - Sequence marker
 * @property {string} DDOC - Design document marker
 * @property {string} NATIVE - Native marker
 * @property {string} INDEX - Index marker
 * @memberOf module:for-couchdb
 */
/**
 * @description Key constants used in CouchDB operations
 * @summary Collection of string constants for CouchDB document properties and operations
 * @const CouchDBKeys
 * @type {CouchDBKeysType}
 * @memberOf module:for-couchdb
 */
exports.CouchDBKeys = {
    SEPARATOR: "__",
    ID: "_id",
    REV: "_rev",
    DELETED: "_deleted",
    TABLE: "??table",
    SEQUENCE: "??sequence",
    DDOC: "ddoc",
    NATIVE: "__native",
    INDEX: "index",
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQTs7Ozs7R0FLRztBQUNVLFFBQUEsa0JBQWtCLEdBQUcsUUFBUSxDQUFDO0FBRTNDOzs7Ozs7Ozs7Ozs7OztHQWNHO0FBRUg7Ozs7OztHQU1HO0FBQ1UsUUFBQSxXQUFXLEdBQUc7SUFDekIsU0FBUyxFQUFFLElBQUk7SUFDZixFQUFFLEVBQUUsS0FBSztJQUNULEdBQUcsRUFBRSxNQUFNO0lBQ1gsT0FBTyxFQUFFLFVBQVU7SUFDbkIsS0FBSyxFQUFFLFNBQVM7SUFDaEIsUUFBUSxFQUFFLFlBQVk7SUFDdEIsSUFBSSxFQUFFLE1BQU07SUFDWixNQUFNLEVBQUUsVUFBVTtJQUNsQixLQUFLLEVBQUUsT0FBTztDQUNmLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBkZXNjcmlwdGlvbiBSZWd1bGFyIGV4cHJlc3Npb24gdG8gaWRlbnRpZnkgcmVzZXJ2ZWQgYXR0cmlidXRlcyBpbiBDb3VjaERCXG4gKiBAc3VtbWFyeSBNYXRjaGVzIGFueSBhdHRyaWJ1dGUgdGhhdCBzdGFydHMgd2l0aCBhbiB1bmRlcnNjb3JlXG4gKiBAY29uc3QgcmVzZXJ2ZWRBdHRyaWJ1dGVzXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmZvci1jb3VjaGRiXG4gKi9cbmV4cG9ydCBjb25zdCByZXNlcnZlZEF0dHJpYnV0ZXMgPSAvXl8uKiQvZztcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gS2V5IGNvbnN0YW50cyB1c2VkIGluIENvdWNoREIgb3BlcmF0aW9uc1xuICogQHN1bW1hcnkgQ29sbGVjdGlvbiBvZiBzdHJpbmcgY29uc3RhbnRzIGZvciBDb3VjaERCIGRvY3VtZW50IHByb3BlcnRpZXMgYW5kIG9wZXJhdGlvbnNcbiAqIEB0eXBlZGVmIHtPYmplY3R9IENvdWNoREJLZXlzVHlwZVxuICogQHByb3BlcnR5IHtzdHJpbmd9IFNFUEFSQVRPUiAtIFNlcGFyYXRvciB1c2VkIGZvciBjb21iaW5pbmcgdGFibGUgbmFtZSBhbmQgSURcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBJRCAtIENvdWNoREIgZG9jdW1lbnQgSUQgZmllbGRcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBSRVYgLSBDb3VjaERCIGRvY3VtZW50IHJldmlzaW9uIGZpZWxkXG4gKiBAcHJvcGVydHkge3N0cmluZ30gREVMRVRFRCAtIENvdWNoREIgZGVsZXRlZCBkb2N1bWVudCBtYXJrZXJcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBUQUJMRSAtIFRhYmxlIG5hbWUgbWFya2VyXG4gKiBAcHJvcGVydHkge3N0cmluZ30gU0VRVUVOQ0UgLSBTZXF1ZW5jZSBtYXJrZXJcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBERE9DIC0gRGVzaWduIGRvY3VtZW50IG1hcmtlclxuICogQHByb3BlcnR5IHtzdHJpbmd9IE5BVElWRSAtIE5hdGl2ZSBtYXJrZXJcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBJTkRFWCAtIEluZGV4IG1hcmtlclxuICogQG1lbWJlck9mIG1vZHVsZTpmb3ItY291Y2hkYlxuICovXG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEtleSBjb25zdGFudHMgdXNlZCBpbiBDb3VjaERCIG9wZXJhdGlvbnNcbiAqIEBzdW1tYXJ5IENvbGxlY3Rpb24gb2Ygc3RyaW5nIGNvbnN0YW50cyBmb3IgQ291Y2hEQiBkb2N1bWVudCBwcm9wZXJ0aWVzIGFuZCBvcGVyYXRpb25zXG4gKiBAY29uc3QgQ291Y2hEQktleXNcbiAqIEB0eXBlIHtDb3VjaERCS2V5c1R5cGV9XG4gKiBAbWVtYmVyT2YgbW9kdWxlOmZvci1jb3VjaGRiXG4gKi9cbmV4cG9ydCBjb25zdCBDb3VjaERCS2V5cyA9IHtcbiAgU0VQQVJBVE9SOiBcIl9fXCIsXG4gIElEOiBcIl9pZFwiLFxuICBSRVY6IFwiX3JldlwiLFxuICBERUxFVEVEOiBcIl9kZWxldGVkXCIsXG4gIFRBQkxFOiBcIj8/dGFibGVcIixcbiAgU0VRVUVOQ0U6IFwiPz9zZXF1ZW5jZVwiLFxuICBERE9DOiBcImRkb2NcIixcbiAgTkFUSVZFOiBcIl9fbmF0aXZlXCIsXG4gIElOREVYOiBcImluZGV4XCIsXG59O1xuIl19