@decaf-ts/for-couchdb
Version:
template for ts projects
41 lines • 4.06 kB
JavaScript
/**
* @description Regular expression to identify reserved attributes in CouchDB
* @summary Matches any attribute that starts with an underscore
* @const reservedAttributes
* @memberOf module:for-couchdb
*/
export const 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
*/
export const CouchDBKeys = {
SEPARATOR: "__",
ID: "_id",
REV: "_rev",
DELETED: "_deleted",
TABLE: "??table",
SEQUENCE: "??sequence",
DDOC: "ddoc",
NATIVE: "__native",
INDEX: "index",
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7R0FLRztBQUNILE1BQU0sQ0FBQyxNQUFNLGtCQUFrQixHQUFHLFFBQVEsQ0FBQztBQUUzQzs7Ozs7Ozs7Ozs7Ozs7R0FjRztBQUVIOzs7Ozs7R0FNRztBQUNILE1BQU0sQ0FBQyxNQUFNLFdBQVcsR0FBRztJQUN6QixTQUFTLEVBQUUsSUFBSTtJQUNmLEVBQUUsRUFBRSxLQUFLO0lBQ1QsR0FBRyxFQUFFLE1BQU07SUFDWCxPQUFPLEVBQUUsVUFBVTtJQUNuQixLQUFLLEVBQUUsU0FBUztJQUNoQixRQUFRLEVBQUUsWUFBWTtJQUN0QixJQUFJLEVBQUUsTUFBTTtJQUNaLE1BQU0sRUFBRSxVQUFVO0lBQ2xCLEtBQUssRUFBRSxPQUFPO0NBQ2YsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQGRlc2NyaXB0aW9uIFJlZ3VsYXIgZXhwcmVzc2lvbiB0byBpZGVudGlmeSByZXNlcnZlZCBhdHRyaWJ1dGVzIGluIENvdWNoREJcbiAqIEBzdW1tYXJ5IE1hdGNoZXMgYW55IGF0dHJpYnV0ZSB0aGF0IHN0YXJ0cyB3aXRoIGFuIHVuZGVyc2NvcmVcbiAqIEBjb25zdCByZXNlcnZlZEF0dHJpYnV0ZXNcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Zm9yLWNvdWNoZGJcbiAqL1xuZXhwb3J0IGNvbnN0IHJlc2VydmVkQXR0cmlidXRlcyA9IC9eXy4qJC9nO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBLZXkgY29uc3RhbnRzIHVzZWQgaW4gQ291Y2hEQiBvcGVyYXRpb25zXG4gKiBAc3VtbWFyeSBDb2xsZWN0aW9uIG9mIHN0cmluZyBjb25zdGFudHMgZm9yIENvdWNoREIgZG9jdW1lbnQgcHJvcGVydGllcyBhbmQgb3BlcmF0aW9uc1xuICogQHR5cGVkZWYge09iamVjdH0gQ291Y2hEQktleXNUeXBlXG4gKiBAcHJvcGVydHkge3N0cmluZ30gU0VQQVJBVE9SIC0gU2VwYXJhdG9yIHVzZWQgZm9yIGNvbWJpbmluZyB0YWJsZSBuYW1lIGFuZCBJRFxuICogQHByb3BlcnR5IHtzdHJpbmd9IElEIC0gQ291Y2hEQiBkb2N1bWVudCBJRCBmaWVsZFxuICogQHByb3BlcnR5IHtzdHJpbmd9IFJFViAtIENvdWNoREIgZG9jdW1lbnQgcmV2aXNpb24gZmllbGRcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBERUxFVEVEIC0gQ291Y2hEQiBkZWxldGVkIGRvY3VtZW50IG1hcmtlclxuICogQHByb3BlcnR5IHtzdHJpbmd9IFRBQkxFIC0gVGFibGUgbmFtZSBtYXJrZXJcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBTRVFVRU5DRSAtIFNlcXVlbmNlIG1hcmtlclxuICogQHByb3BlcnR5IHtzdHJpbmd9IERET0MgLSBEZXNpZ24gZG9jdW1lbnQgbWFya2VyXG4gKiBAcHJvcGVydHkge3N0cmluZ30gTkFUSVZFIC0gTmF0aXZlIG1hcmtlclxuICogQHByb3BlcnR5IHtzdHJpbmd9IElOREVYIC0gSW5kZXggbWFya2VyXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmZvci1jb3VjaGRiXG4gKi9cblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gS2V5IGNvbnN0YW50cyB1c2VkIGluIENvdWNoREIgb3BlcmF0aW9uc1xuICogQHN1bW1hcnkgQ29sbGVjdGlvbiBvZiBzdHJpbmcgY29uc3RhbnRzIGZvciBDb3VjaERCIGRvY3VtZW50IHByb3BlcnRpZXMgYW5kIG9wZXJhdGlvbnNcbiAqIEBjb25zdCBDb3VjaERCS2V5c1xuICogQHR5cGUge0NvdWNoREJLZXlzVHlwZX1cbiAqIEBtZW1iZXJPZiBtb2R1bGU6Zm9yLWNvdWNoZGJcbiAqL1xuZXhwb3J0IGNvbnN0IENvdWNoREJLZXlzID0ge1xuICBTRVBBUkFUT1I6IFwiX19cIixcbiAgSUQ6IFwiX2lkXCIsXG4gIFJFVjogXCJfcmV2XCIsXG4gIERFTEVURUQ6IFwiX2RlbGV0ZWRcIixcbiAgVEFCTEU6IFwiPz90YWJsZVwiLFxuICBTRVFVRU5DRTogXCI/P3NlcXVlbmNlXCIsXG4gIERET0M6IFwiZGRvY1wiLFxuICBOQVRJVkU6IFwiX19uYXRpdmVcIixcbiAgSU5ERVg6IFwiaW5kZXhcIixcbn07XG4iXX0=