withMetadata TypeScript definition is missing boolean type

[uhthomas]

Possible bug

Is this a possible bug in a feature of sharp, unrelated to installation?

• Running npm install sharp completes without error.
• Running node -e "require('sharp')" completes without error.

If you cannot confirm both of these, please open an installation issue instead.

Are you using the latest version of sharp?

• I am using the latest version of sharp as reported by npm view sharp dist-tags.latest.

If you cannot confirm this, please upgrade to the latest version and try again before opening an issue.

If you are using another package which depends on a version of sharp that is not the latest, please open an issue against that package instead.

What is the output of running npx envinfo --binaries --system --npmPackages=sharp --npmGlobalPackages=sharp?

What are the steps to reproduce?

The withMetadata implementation checks for a boolean and therefore implies it is valid to provide one as an argument. The TypeScript definition however does not indicate this.

src/infra/repositories/media.repository.ts:35:21 - error TS2559: Type 'false' has no properties in common with type 'WriteableMetadata'.

What is the expected behaviour?

withMetadata(withMetadata?: boolean | WriteableMetadata): Sharp;

Please provide a minimal, standalone code sample, without other dependencies, that demonstrates this problem

Please provide sample image(s) that help explain this problem

[lovell]

It looks like the work for #3824 may supersede this fix as parts of the withMetadata() API are being deprecated and most scenarios should switch to use the (proposed) keepX() methods instead.

[lovell]

v0.33.0 is now available.