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

Docs: overlay parameter of overlayWith is optional (#1547)

Browse Source
This commit is contained in:
Maxime BACONNAIS 2019-01-19 15:19:41 +01:00 committed by Lovell Fuller
parent 98e90784f4
commit 1df8d82fe0
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api-composite.md
View File

@ -11,7 +11,7 @@ If the overlay image contains an alpha channel then composition with premultipli
### Parameters ### Parameters
- `overlay` **([Buffer][1] \| [String][2])** Buffer containing image data or String containing the path to an image file. - `overlay` **([Buffer][1] \| [String][2])?** Buffer containing image data or String containing the path to an image file.
- `options` **[Object][3]?** - `options` **[Object][3]?**
- `options.gravity` **[String][2]** gravity at which to place the overlay. (optional, default `'centre'`) - `options.gravity` **[String][2]** gravity at which to place the overlay. (optional, default `'centre'`)
- `options.top` **[Number][4]?** the pixel offset from the top edge. - `options.top` **[Number][4]?** the pixel offset from the top edge.