Skip to content

Commit

Permalink
Regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lovell committed Nov 2, 2016
1 parent 4af702e commit 5599870
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 5 deletions.
3 changes: 1 addition & 2 deletions docs/api-channel.md
Expand Up @@ -39,8 +39,7 @@ For raw pixel input, the `options` object should contain a `raw` attribute, whic
**Parameters**

- `images` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Buffer](https://nodejs.org/api/buffer.html))** one or more images (file paths, Buffers).
- `Object` image options, see `sharp()` constructor.
- `options`
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** image options, see `sharp()` constructor.


- Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** Invalid parameters
Expand Down
3 changes: 1 addition & 2 deletions docs/api-utility.md
Expand Up @@ -9,8 +9,7 @@ useful for determining how much working memory is required for a particular task

**Parameters**

- `Object` **([Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) \| [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean))** with the following attributes, or Boolean where true uses default cache settings and false removes all caching.
- `options`
- `options` **([Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) \| [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean))** Object with the following attributes, or Boolean where true uses default cache settings and false removes all caching.
- `options.memory` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** is the maximum memory in MB to use for this cache (optional, default `50`)
- `options.files` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** is the maximum number of files to hold open (optional, default `20`)
- `options.items` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** is the maximum number of operations to cache (optional, default `100`)
Expand Down
2 changes: 1 addition & 1 deletion package.json 100755 → 100644
Expand Up @@ -74,7 +74,7 @@
"icc": "^0.0.2",
"mocha": "^3.1.2",
"node-cpplint": "^0.4.0",
"nyc": "^8.3.2",
"nyc": "^8.4.0",
"rimraf": "^2.5.4",
"semistandard": "^9.1.0",
"unzip": "^0.1.11"
Expand Down

0 comments on commit 5599870

Please sign in to comment.