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

@@ -589,6 +589,20 @@ Time spent waiting for a libuv thread to become available is not included.
* `options.seconds` **[number][12]** Number of seconds after which processing will be stopped
### Examples
```javascript
// 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')) { ... }
}
```
Returns **Sharp**
**Meta**