Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-09 18:40:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation of cache method

Browse Source
This commit is contained in:
Lovell Fuller 2014-02-28 22:37:59 +00:00
parent d5d85a8697
commit 31ca68fb14
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -103,11 +103,11 @@ sharp.resize("input.jpg", sharp.buffer.webp, 200, 300, {canvas: sharp.canvas.emb
### cache([limit]) ### cache([limit])
If `limit` is provided, set the `vips` internal cache limit to this value in MB. The default value is 100. If `limit` is provided, set the (soft) limit of _libvips_ working/cache memory to this value in MB. The default value is 100.
Always returns cache statistics, namely current usage, high water mark and maximum limit. This method always returns cache statistics, useful for determining how much working memory is required for a particular task.
The high water mark may be higher than the maximum limit. Warnings such as _Application transferred too many scanlines_ are a good indicator you've set this value too low.
```javascript ```javascript
var stats = sharp.cache(); // { current: 98, high: 115, limit: 100 } var stats = sharp.cache(); // { current: 98, high: 115, limit: 100 }