geospatial and suggest jsdoc

Author: ehennum

lib/documents.js

@@ -1339,6 +1339,23 @@ function patchDocuments() {
   return mlrest.startRequest(operation);
 }
 
+/**
+ * For a partial textual value in a string search, looks up completions
+ * that match documents in the database. The textual value may be
+ * prefixed with the tag for a binding or an unqualified word or phrase.
+ * You may pass a configuration object with
+ * the following named parameters or, as a shortcut, the input string and
+ * optionally the bindings.
+ * @method documents#suggest
+ * @param {string} input - the partial search string
+ * @param {queryBuilder.ParseBindings} [bindings] - the bindings for
+ * the string search as returned by the {@link queryBuilder#parseBindings}
+ * function
+ * @param {number} [limit] - the number of completion candidates to return
+ * @returns {ResultProvider} an object whose result() function takes
+ * a success callback that receives an array with the candidate completion
+ * strings.
+ */
 function suggestDocuments() {
   var argLen = arguments.length;
   if (argLen < 1) {
@@ -1436,6 +1453,7 @@ persisted query options
   return mlrest.startRequest(operation);
 }
 
+/** @ignore */
 function copyConstraint(destination, constraints) {
   if (valcheck.isArray(constraints)) {
     var isCopyKey = {