docs: add example to SchemaNumberOptions#enum

Automattic · Dec 24, 2019 · 7fae539 · 7fae539
1 parent 979fb87
commit 7fae539
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/lib/options/SchemaNumberOptions.js b/lib/options/SchemaNumberOptions.js
@@ -48,6 +48,15 @@ Object.defineProperty(SchemaNumberOptions.prototype, 'max', opts);
 /**
  * If set, Mongoose adds a validator that checks that this path is strictly
  * equal to one of the given values.
+ * 
+ * ####Example:
+ *     const schema = new Schema({
+ *       favoritePrime: {
+ *         type: Number,
+ *         enum: [3, 5, 7]
+ *       }
+ *     });
+ *     schema.path('favoritePrime').options.enum; // [3, 5, 7]
  *
  * @api public
  * @property enum