From 3939f77188bca61f08d00bf40c337ca36a19790c Mon Sep 17 00:00:00 2001 From: Gabriel Grubba Date: Fri, 25 Nov 2022 11:32:29 -0300 Subject: [PATCH] docs: added a depracieation note --- packages/mongo-async/collection.js | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/packages/mongo-async/collection.js b/packages/mongo-async/collection.js index b4878e725f..874e43821b 100644 --- a/packages/mongo-async/collection.js +++ b/packages/mongo-async/collection.js @@ -745,6 +745,19 @@ Object.assign(Mongo.Collection.prototype, { // We'll actually design an index API later. For now, we just pass through to // Mongo's, but make it synchronous. + /** + * @summary Creates the specified index on the collection. + * @locus server + * @deprecated in 3.0 + * @method createIndex + * @memberof Mongo.Collection + * @instance + * @param {Object} index A document that contains the field and value pairs where the field is the index key and the value describes the type of index for that field. For an ascending index on a field, specify a value of `1`; for descending index, specify a value of `-1`. Use `text` for text indexes. + * @param {Object} [options] All options are listed in [MongoDB documentation](https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options) + * @param {String} options.name Name of the index + * @param {Boolean} options.unique Define that the index values must be unique, more at [MongoDB documentation](https://docs.mongodb.com/manual/core/index-unique/) + * @param {Boolean} options.sparse Define that the index is sparse, more at [MongoDB documentation](https://docs.mongodb.com/manual/core/index-sparse/) + */ async _ensureIndex(index, options) { var self = this; if (!self._collection._ensureIndex || !self._collection.createIndex)