Skip to content

Commit

Permalink
Docs: overlay parameter of overlayWith is optional (#1547)
Browse files Browse the repository at this point in the history
  • Loading branch information
Maxou44 authored and lovell committed Jan 19, 2019
1 parent 98e9078 commit 1df8d82
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/api-composite.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If the overlay image contains an alpha channel then composition with premultipli

### 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.gravity` **[String][2]** gravity at which to place the overlay. (optional, default `'centre'`)
- `options.top` **[Number][4]?** the pixel offset from the top edge.
Expand Down

0 comments on commit 1df8d82

Please sign in to comment.