docs: updated vision detect params/examples (#1500)

callmehiphop · stephenplusplus · commit 353d9f236ee5 · 2016-08-29T18:03:27.000-04:00
* docs: updated vision detect params/examples

* updated buffer example
diff --git a/packages/vision/src/index.js b/packages/vision/src/index.js
@@ -133,6 +133,7 @@ Vision.prototype.annotate = function(requests, callback) {
   });
 };
 
+// jscs:disable maximumLineLength
 /**
  * Detect properties from an image (or images) of one or more types.
  *
@@ -156,9 +157,10 @@ Vision.prototype.annotate = function(requests, callback) {
  * For the response in the original format, review the `apiResponse` argument
  * your callback receives.
  *
- * @param {string|string[]|module:storage/file|module:storage/file[]} images -
- *     The source image(s) to run the detection on. It can be either a local
- *     image path, a remote image URL, or a @google-cloud/storage File object.
+ * @param {string|string[]|buffer|buffer[]|module:storage/file|module:storage/file[]} images - The
+ *     source image(s) to run the detection on. It can be either a local image
+ *     path, a remote image URL, a Buffer, or a @google-cloud/storage File
+ *     object.
  * @param {string[]|object=} options - An array of types or a configuration
  *     object.
  * @param {object=} options.imageContext - See an
@@ -210,6 +212,20 @@ Vision.prototype.annotate = function(requests, callback) {
  * vision.detect(img, types, function(err, detection, apiResponse) {});
  *
  * //-
+ * // Run feature detection over a Buffer.
+ * //-
+ * var level = require('level');
+ * var db = level('./users-database');
+ *
+ * db.get('user-image', { encoding: 'binary' }, function(err, image) {
+ *   if (err) {
+ *     // Error handling omitted.
+ *   }
+ *
+ *   vision.detect(image, function(err, detection, apiResponse) {});
+ * });
+ *
+ * //-
  * // Supply multiple images for feature detection.
  * //-
  * var images = [
@@ -519,6 +535,7 @@ Vision.prototype.detect = function(images, options, callback) {
     });
   });
 };
+// jscs:enable maximumLineLength
 
 /**
  * Run face detection against an image.
diff --git a/test/docs.js b/test/docs.js
@@ -135,6 +135,15 @@ describe('documentation', function() {
         };
       }
 
+      // For {module:vision} docs.
+      function FakeLevel() {
+        return {
+          get: function(key, options, callback) {
+            callback(null, 'image.jpg');
+          }
+        };
+      }
+
       fileDocBlocks.methods.forEach(function(method) {
         var code = method.examples.map(prop('code')).join('\n');
         var lowercaseId = method.id.toLowerCase();
@@ -171,7 +180,8 @@ describe('documentation', function() {
             /require\('(@google-cloud\/[^']*)/g,
             'require(\'../packages/' + directory + '/node_modules/$1'
           )
-          .replace('require(\'express\')', FakeExpress.toString());
+          .replace('require(\'express\')', FakeExpress.toString())
+          .replace('require(\'level\')', FakeLevel.toString());
 
         var displayName = filename
           .replace('docs/json/master/', '')
