ottoman
Version:
Ottoman Couchbase ODM
42 lines (41 loc) • 1.14 kB
TypeScript
/**
* Default value for metadata key, to keep collection tracking
* eg. This model new Model('User', schema, options), will generate documents -> document._type = 'User'
*/
export declare const MODEL_KEY = "_type";
/**
* Key to add document metadata identifier
* This key will store the value of the key,
* key -> document, document.id === key
*/
export declare const DEFAULT_ID_KEY = "id";
/**
* Default scope name.
*/
export declare const DEFAULT_SCOPE = "_default";
/**
* Default collection name.
*/
export declare const DEFAULT_COLLECTION = "_default";
/**
* Default KeyGenerator function.
*/
export declare const KEY_GENERATOR: ({ metadata }: {
metadata: any;
}) => string;
/**
* Default KeyGeneratorDelimiter value.
*/
export declare const KEY_GENERATOR_DELIMITER = "::";
/**
* Internal KeyGenerator function.
* @param keyGen
* @param metadata
* @param id
*/
export declare const _keyGenerator: (keyGen: any, { metadata, id }: {
metadata: any;
id: any;
}, delimeter?: string) => any;
export declare const validateDelimiter: (delimiter: string) => void;
export declare const DEFAULT_MAX_EXPIRY = 0;