Extended skiplist/hash index opts. Fixes #55.

Author: pluma

README.md

@@ -1560,14 +1560,16 @@ db.createCollection('some-collection', function (err, collection) {
 
 #### collection.createHashIndex
 
-`collection.createHashIndex(fields: Array<string> | string, [unique: boolean,] [callback: Callback]): Promise<Index>`
+`collection.createHashIndex(fields: Array<string> | string, [opts: Object | boolean,] [callback: Callback]): Promise<Index>`
 
 Creates a hash index on the collection.
 
 *Parameter*
 
 * *fields*: an array of document fields on which to create the index.
-* *unique* (optional): whether to constrain the fields to unique values. Default: `false`.
+* *opts* (optional): additional options for this index.
+
+If *opts* is a boolean, it will be interpreted as *opts.unique*.
 
 If *fields* is a string, it will be wrapped in an array automatically.
 
@@ -1597,14 +1599,16 @@ db.createCollection('some-collection', function (err, collection) {
 
 #### collection.createSkipList
 
-`collection.createSkipList(fields: Array<string> | string, [unique: boolean,] [callback: Callback]): Promise<Index>`
+`collection.createSkipList(fields: Array<string> | string, [opts: Object | boolean,] [opts: Object,] [callback: Callback]): Promise<Index>`
 
 Creates a skiplist index on the collection.
 
 *Parameter*
 
 * *fields*: an array of document fields on which to create the index.
-* *unique* (optional): whether to constrain the fields to unique values. Default: `false`.
+* *opts* (optional): additional options for this index.
+
+If *opts* is a boolean, it will be interpreted as *opts.unique*.
 
 If *fields* is a string, it will be wrapped in an array automatically.
 

src/collection.js

@@ -261,39 +261,39 @@ extend(BaseCollection.prototype, {
     });
     return promise;
   },
-  createHashIndex(fields, unique, cb) {
-    if (typeof unique === 'function') {
-      cb = unique;
-      unique = undefined;
+  createHashIndex(fields, opts, cb) {
+    if (typeof opts === 'function') {
+      cb = opts;
+      opts = undefined;
     }
     if (typeof fields === 'string') {
       fields = [fields];
     }
+    if (typeof opts === 'boolean') {
+      opts = {unique: opts};
+    }
     var {promise, callback} = this._connection.promisify(cb);
-    this._api.post('index', {
-      type: 'hash',
-      fields: fields,
-      unique: Boolean(unique)
-    }, {collection: this.name}, function (err, res) {
+    opts = extend({unique: false}, opts, {type: 'hash', fields: fields});
+    this._api.post('index', opts, {collection: this.name}, function (err, res) {
       if (err) callback(err);
       else callback(null, res.body);
     });
     return promise;
   },
-  createSkipList(fields, unique, cb) {
-    if (typeof unique === 'function') {
-      cb = unique;
-      unique = undefined;
+  createSkipList(fields, opts, cb) {
+    if (typeof opts === 'function') {
+      cb = opts;
+      opts = undefined;
     }
     if (typeof fields === 'string') {
       fields = [fields];
     }
+    if (typeof opts === 'boolean') {
+      opts = {unique: opts};
+    }
     var {promise, callback} = this._connection.promisify(cb);
-    this._api.post('index', {
-      type: 'skiplist',
-      fields: fields,
-      unique: Boolean(unique)
-    }, {collection: this.name}, function (err, res) {
+    opts = extend({unique: false}, opts, {type: 'skiplist', fields: fields});
+    this._api.post('index', opts, {collection: this.name}, function (err, res) {
       if (err) callback(err);
       else callback(null, res.body);
     });