Docs: ensure alpha attribute is used for transparency

lovell · Jan 13, 2017 · 4730554 · 4730554
1 parent c6a28db
commit 4730554
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/api-operation.md b/docs/api-operation.md
@@ -169,7 +169,7 @@ This operation will always occur after resizing and extraction, if any.
 // to the top, left and right edges and 20 to the bottom edge
 sharp(input)
   .resize(140)
-  .background({r: 0, g: 0, b: 0, a: 0})
+  .background({r: 0, g: 0, b: 0, alpha: 0})
   .extend({top: 10, bottom: 20, left: 10, right: 10})
   ...
 ```

diff --git a/docs/api-resize.md b/docs/api-resize.md
@@ -110,7 +110,7 @@ contain an alpha channel, even when the input image does not.
 ```javascript
 sharp('input.gif')
   .resize(200, 300)
-  .background({r: 0, g: 0, b: 0, a: 0})
+  .background({r: 0, g: 0, b: 0, alpha: 0})
   .embed()
   .toFormat(sharp.format.webp)
   .toBuffer(function(err, outputBuffer) {

diff --git a/lib/resize.js b/lib/resize.js
@@ -200,7 +200,7 @@ const crop = function crop (crop) {
  * @example
  * sharp('input.gif')
  *   .resize(200, 300)
- *   .background({r: 0, g: 0, b: 0, a: 0})
+ *   .background({r: 0, g: 0, b: 0, alpha: 0})
  *   .embed()
  *   .toFormat(sharp.format.webp)
  *   .toBuffer(function(err, outputBuffer) {