chris
746868d720
git-subtree-dir: main-site git-subtree-mainline: 4d1daa39101c0a85ca6d916f1c31139faf39632a git-subtree-split: 5cefb4d1618bc54ae0e86830421a8c911900302c
44 lines
1.1 KiB
JavaScript
44 lines
1.1 KiB
JavaScript
'use strict';
|
|
|
|
const SchemaTypeOptions = require('./schemaTypeOptions');
|
|
|
|
/**
|
|
* The options defined on a Map schematype.
|
|
*
|
|
* #### Example:
|
|
*
|
|
* const schema = new Schema({ socialMediaHandles: { type: Map, of: String } });
|
|
* schema.path('socialMediaHandles').options; // SchemaMapOptions instance
|
|
*
|
|
* @api public
|
|
* @inherits SchemaTypeOptions
|
|
* @constructor SchemaMapOptions
|
|
*/
|
|
|
|
class SchemaMapOptions extends SchemaTypeOptions {}
|
|
|
|
const opts = require('./propertyOptions');
|
|
|
|
/**
|
|
* If set, specifies the type of this map's values. Mongoose will cast
|
|
* this map's values to the given type.
|
|
*
|
|
* If not set, Mongoose will not cast the map's values.
|
|
*
|
|
* #### Example:
|
|
*
|
|
* // Mongoose will cast `socialMediaHandles` values to strings
|
|
* const schema = new Schema({ socialMediaHandles: { type: Map, of: String } });
|
|
* schema.path('socialMediaHandles').options.of; // String
|
|
*
|
|
* @api public
|
|
* @property of
|
|
* @memberOf SchemaMapOptions
|
|
* @type {Function|string}
|
|
* @instance
|
|
*/
|
|
|
|
Object.defineProperty(SchemaMapOptions.prototype, 'of', opts);
|
|
|
|
module.exports = SchemaMapOptions;
|