Deprecation notice: move background function to relevant operations, affects embed/extend/flatten

[lovell]

This is advance warning that the background method will be deprecated in v0.21.0 and instead become separate options of the operations it affects.

embed

The following:

sharp(input)
  .background({
    r: 0,
    g: 255,
    b: 0,
    alpha: 0.1
  })
  .resize(200, 300)
  .embed()
  ...

when combined with #1135 will become:

sharp(input)
  .resize({
    width: 200,
    height: 300,
    fit: 'contain',
    background: {
      r: 0,
      g: 255,
      b: 0,
      alpha: 0.1
    }
  })
  ...

extend

The following:

sharp(input)
  .background({
    r: 255,
    g: 0,
    b: 0,
    alpha: 0.5
  })
  .extend({
    top: 10,
    bottom: 20,
    left: 10,
    right: 10
  })
  ...

will become:

sharp(input)
  .extend({
    top: 10,
    bottom: 20,
    left: 10,
    right: 10,
    background: {
      r: 255,
      g: 0,
      b: 0,
      alpha: 0.5
    }
  })
  ...

flatten

The following:

sharp(input)
  .background('red')
  .flatten()
  ...

will become:

sharp(input)
  .flatten({
    background: 'red'
  })
  ...

[lovell]

Commit a648446 deprecates background from v0.21.0 (and will be removed in v0.22.0).

[lovell]

v0.21.0 now available with this change.

[rn4391]

How do we just add a background to a PNG image with transparency - no other transform, just replace the transparency with a color?

[lovell]

@rn4391 Please can you create a new issue with your question and an example of what you've tried that didn't work e.g. flatten