Docs: add timeout example

This commit is contained in:
Lovell Fuller
2022-07-11 11:12:32 +01:00
parent 905518fab0
commit e4160c684d
3 changed files with 25 additions and 1 deletions

View File

@@ -1050,6 +1050,17 @@ function tile (options) {
* The clock starts when libvips opens an input image for processing.
* Time spent waiting for a libuv thread to become available is not included.
*
* @example
* // Ensure processing takes no longer than 3 seconds
* try {
* const data = await sharp(input)
* .blur(1000)
* .timeout({ seconds: 3 })
* .toBuffer();
* } catch (err) {
* if (err.message.includes('timeout')) { ... }
* }
*
* @since 0.29.2
*
* @param {Object} options