TypeScript: add missing definitions for OverlayOptions (#4048)

This commit is contained in:
ike 2024-04-02 15:42:10 +02:00 committed by GitHub
parent 02fd565476
commit 0981b24f60
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 29 additions and 0 deletions

8
lib/index.d.ts vendored
View File

@ -1479,6 +1479,14 @@ declare namespace sharp {
tile?: boolean | undefined; tile?: boolean | undefined;
/** Set to true to avoid premultipling the image below. Equivalent to the --premultiplied vips option. */ /** Set to true to avoid premultipling the image below. Equivalent to the --premultiplied vips option. */
premultiplied?: boolean | undefined; premultiplied?: boolean | undefined;
/** number representing the DPI for vector overlay image. (optional, default 72)*/
density?: number | undefined;
/** Set to true to read all frames/pages of an animated image. (optional, default false) */
animated?: boolean | undefined;
/** see sharp() constructor, (optional, default 'warning') */
failOn?: FailOnOptions | undefined;
/** see sharp() constructor, (optional, default 268402689) */
limitInputPixels?: number | boolean | undefined;
} }
interface TileOptions { interface TileOptions {

View File

@ -680,3 +680,24 @@ sharp(input)
.keepIccProfile() .keepIccProfile()
.withIccProfile('filename') .withIccProfile('filename')
.withIccProfile('filename', { attach: false }); .withIccProfile('filename', { attach: false });
// Added missing types for OverlayOptions
// https://github.com/lovell/sharp/pull/4048
sharp(input).composite([
{
input: 'image.gif',
animated: true,
limitInputPixels: 536805378,
density: 144,
failOn: "warning"
}
])
sharp(input).composite([
{
input: 'image.png',
animated: false,
limitInputPixels: 178935126,
density: 72,
failOn: "truncated"
}
])