Docs: clarify that flatten removes alpha channel #2601

lovell · Mar 25, 2021 · f1f18fb · f1f18fb
1 parent 9fc611f
commit f1f18fb
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 3 deletions.
diff --git a/docs/api-operation.md b/docs/api-operation.md
@@ -169,13 +169,21 @@ Returns **Sharp**
 
 ## flatten
 
-Merge alpha transparency channel, if any, with a background.
+Merge alpha transparency channel, if any, with a background, then remove the alpha channel.
 
 ### Parameters
 
 -   `options` **[Object][2]?** 
     -   `options.background` **([string][3] \| [Object][2])** background colour, parsed by the [color][4] module, defaults to black. (optional, default `{r:0,g:0,b:0}`)
 
+### Examples
+
+```javascript
+await sharp(rgbaInput)
+  .flatten('#F0A703')
+  .toBuffer();
+```
+
 Returns **Sharp** 
 
 ## gamma