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

This commit is contained in:
Aditya Bharti
2017-10-15 13:58:08 +05:30
committed by Lovell Fuller
parent bbe897e607
commit aad16ac50d
2 changed files with 6 additions and 0 deletions

View File

@@ -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}
*/