return string only when a string is supplied, jsdoc #42

Author: ehennum

lib/documents.js

@@ -1066,7 +1066,7 @@ function removeOutputTransform(headers, data) {
 
   if (operation.contentOnly === true) {
     // for deprecated backward compatibility
-    return (operation.uris.length === 1) ? operation.uris[0] : operation.uris;
+    return operation.isLegacy ? operation.uris[0] : operation.uris;
   }
 
   var wrapper = {
@@ -1108,9 +1108,11 @@ function removeOutputTransform(headers, data) {
  * a {@link documents#removeResult} success callback.
  */
 function removeDocument() {
-  return removeDocumentImpl.call(this, false, mlutil.asArray.apply(null, arguments));
+  return removeDocumentImpl.call(
+      this, false, false, mlutil.asArray.apply(null, arguments)
+      );
 }
-function removeDocumentImpl(contentOnly, args) {
+function removeDocumentImpl(contentOnly, isLegacy, args) {
   if (args.length < 1) {
     throw new Error('must provide uris for document remove()');
   }
@@ -1178,6 +1180,7 @@ function removeDocumentImpl(contentOnly, args) {
   operation.outputTransform  = removeOutputTransform;
   operation.errorTransform   = uriErrorTransform;
   operation.contentOnly      = (contentOnly === true);
+  operation.isLegacy         = isLegacy;
 
   return mlrest.startRequest(operation);
 }

lib/marklogic.js

@@ -442,11 +442,18 @@ MarkLogicClient.prototype.read = readClient;
  * @param {string|string[]}  uris - the uri string or an array of uri strings
  * identifying the database documents
  * @returns {ResultProvider} an object whose result() function takes
- * a success callback that receives the uri string or an array of uris strings
- * identifying the removed documents.
+ * a success callback that receives the uris identifying the removed documents.
+ * For backward compatibility, if a string ispassed, the uri is returned
+ * as a string, but in the next major release, the uri will be return
+ * as an array with one string.
  */
 function removeClient() {
-  return documents.removeImpl.call(this.documents, true, mlutil.asArray.apply(null, arguments));
+  return documents.removeImpl.call(
+      this.documents,
+      true,
+      (arguments.length === 1 && valcheck.isString(arguments[0])),
+      mlutil.asArray.apply(null, arguments)
+      );
 }
 MarkLogicClient.prototype.remove = removeClient;
 /**