Changelog and doc refresh for #915

docs/api-input.md

@@ -4,6 +4,7 @@
 
 -   [clone](#clone)
 -   [metadata](#metadata)
+-   [stats](#stats)
 -   [limitInputPixels](#limitinputpixels)
 -   [sequentialRead](#sequentialread)
 
@@ -69,8 +70,8 @@ Returns **([Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Ref
 
 ## stats
 
-Access to pixel-derived image statistics for every channel in the image
+Access to pixel-derived image statistics for every channel in the image.
-A Promises/A+ promise is returned when `callback` is not provided.
+A Promise is returned when `callback` is not provided.
 
 -   `channels`: Array of channel statistics for each channel in the image. Each channel statistic contains
     -   `min` (minimum value in the channel)
@@ -87,7 +88,7 @@ A Promises/A+ promise is returned when `callback` is not provided.
 
 **Parameters**
 
--   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?** called with the arguments `(err, metadata)`
+-   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?** called with the arguments `(err, stats)`
 
 **Examples**
 
@@ -97,11 +98,10 @@ image
   .stats()
   .then(function(stats) {
      // stats contains the channel-wise statistics array and the isOpaque value
-  })
+  });
 ```
 
-Returns **([Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)> | Sharp)** 
+Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** 
-
 
 ## limitInputPixels
 

docs/changelog.md

@@ -14,6 +14,10 @@ Requires libvips v8.6.0.
   [#872](https://github.com/lovell/sharp/issues/872)
   [@wmertens](https://github.com/wmertens)
 
+* Add stats feature for pixel-derived image statistics.
+  [#915](https://github.com/lovell/sharp/pull/915)
+  [@rnanwani](https://github.com/rnanwani)
+
 * Add failOnError option to fail-fast on bad input image data.
   [#976](https://github.com/lovell/sharp/pull/976)
   [@mceachen](https://github.com/mceachen)

lib/input.js

@@ -239,8 +239,8 @@ function metadata (callback) {
 }
 
 /**
- * Access to pixel-derived image statistics for every channel in the image
+ * Access to pixel-derived image statistics for every channel in the image.
- * A Promise/A+ promise is returned when `callback` is not provided.
+ * A Promise is returned when `callback` is not provided.
  *
  * - `channels`: Array of channel statistics for each channel in the image. Each channel statistic contains
  *     - `min` (minimum value in the channel)
@@ -261,11 +261,10 @@ function metadata (callback) {
  *   .stats()
  *   .then(function(stats) {
  *      // stats contains the channel-wise statistics array and the isOpaque value
- *   })
+ *   });
- *
  *
  * @param {Function} [callback] - called with the arguments `(err, stats)`
- * @returns {Promise<Object>|Sharp}
+ * @returns {Promise<Object>}
  */
 function stats (callback) {
   const that = this;