Update lib/schema.js

Co-authored-by: hasezoey <hasezoey@gmail.com>
Automattic · Jan 13, 2024 · ab28496 · ab28496
1 parent d1e3c81
commit ab28496
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/schema.js b/lib/schema.js
@@ -919,6 +919,9 @@ Schema.prototype.clearIndexes = function clearIndexes() {
  *     const ToySchema = new Schema({ name: String, color: String, price: Number });
  *     ToySchema.searchIndex({ name: 'test', definition: { mappings: { dynamic: true } } });
  *
+ * @param {Object} description index options, including `name` and `definition`
+ * @param {String} description.name
+ * @param {Object} description.definition
  * @return {Schema} the Schema instance
  * @api public
  */