Improved jsdocs for withoutEnlargement and sequentialRead #972 (#992)

lovell · Oct 15, 2017 · aad16ac · aad16ac
1 parent bbe897e
commit aad16ac
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/lib/input.js b/lib/input.js
@@ -256,6 +256,9 @@ function limitInputPixels (limit) {
 /**
  * An advanced setting that switches the libvips access method to `VIPS_ACCESS_SEQUENTIAL`.
  * This will reduce memory usage and can improve performance on some systems.
+ *
+ * The default behaviour *before* function call is `false`, meaning the libvips access method is not sequential.
+ *
  * @param {Boolean} [sequentialRead=true]
  * @returns {Sharp}
  */

diff --git a/lib/resize.js b/lib/resize.js
@@ -274,6 +274,9 @@ function ignoreAspectRatio () {
  * Do not enlarge the output image if the input image width *or* height are already less than the required dimensions.
  * This is equivalent to GraphicsMagick's `>` geometry option:
  * "*change the dimensions of the image only if its width or height exceeds the geometry specification*".
+ *
+ * The default behaviour *before* function call is `false`, meaning the image will be enlarged.
+ *
  * @param {Boolean} [withoutEnlargement=true]
  * @returns {Sharp}
 */