Skip to content

sharp: add types for jp2() that is used for jpeg 2000 output #59678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 1 commit into from
Apr 4, 2022
Merged

sharp: add types for jp2() that is used for jpeg 2000 output #59678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions types/sharp/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,6 +536,14 @@ declare namespace sharp {
*/
jpeg(options?: JpegOptions): Sharp;

/**
* Use these JP2 (JPEG 2000) options for output image.
* @param options Output options.
* @throws {Error} Invalid options
* @returns A sharp instance that can be used to chain operations
*/
jp2: (options?: Jp2Options) => Sharp;

/**
* Use these PNG options for output image.
* PNG output is always full colour at 8 or 16 bits per pixel.
Expand Down Expand Up @@ -927,6 +935,19 @@ declare namespace sharp {
mozjpeg?: boolean | undefined;
}

interface Jp2Options extends OutputOptions {
/** Quality, integer 1-100 (optional, default 80) */
quality?: number;
/** Use lossless compression mode (optional, default false) */
lossless?: boolean;
/** Horizontal tile size (optional, default 512) */
tileWidth?: number;
/** Vertical tile size (optional, default 512) */
tileHeight?: number;
/** Set to '4:2:0' to enable chroma subsampling (optional, default '4:4:4') */
chromaSubsampling?: '4:4:4' | '4:2:0';
}

interface WebpOptions extends OutputOptions, AnimationOptions {
/** Quality, integer 1-100 (optional, default 80) */
quality?: number | undefined;
Expand Down
7 changes: 7 additions & 0 deletions types/sharp/sharp-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,3 +481,10 @@ sharp('input.gif').png({ dither: 0.5 }).toFile('out.png');

// Support for `resolutionUnit` for tiff output
sharp('input.tiff').tiff({ resolutionUnit: 'cm' }).toFile('out.tiff');

// Support for `jp2` output with different options
sharp('input.tiff').jp2().toFile('out.jp2');
sharp('input.tiff').jp2({ quality: 50 }).toFile('out.jp2');
sharp('input.tiff').jp2({ lossless: true }).toFile('out.jp2');
sharp('input.tiff').jp2({ tileWidth: 128, tileHeight: 128 }).toFile('out.jp2');
sharp('input.tiff').jp2({ chromaSubsampling: '4:2:0' }).toFile('out.jp2');