'jp2' and 'v' does not exist in sharp.format object

[Juneezee]

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?

  System:
    OS: Linux 6.17 Arch Linux
    CPU: (16) x64 AMD Ryzen 7 PRO 4750U with Radeon Graphics
    Memory: 16.33 GB / 22.84 GB
    Container: Yes
    Shell: 5.9 - /usr/bin/zsh
  Binaries:
    Node: 24.10.0 - /home/jun/.nvm/versions/node/v24.10.0/bin/node
    npm: 11.6.1 - /home/jun/.nvm/versions/node/v24.10.0/bin/npm

Does this problem relate to file caching?

The default behaviour of libvips is to cache input files, which can lead to EBUSY or EPERM errors on Windows.
Use sharp.cache(false) to switch this feature off.

• Adding sharp.cache(false) does not fix this problem.

Does this problem relate to images appearing to have been rotated by 90 degrees?

Images that contain EXIF Orientation metadata are not auto-oriented. By default, EXIF metadata is removed.

• To auto-orient pixel values use the parameter-less rotate() operation.

• To retain EXIF Orientation use keepExif().

• Using rotate() or keepExif() does not fix this problem.

What are the steps to reproduce?

1. Copy the provided minimal reproducible code below into main.ts file
2. Run node main.ts (Node v22.18.0 or later required for native TypeScript support)

What is the expected behaviour?

According to the TypeScript definitions, sharp.format should return a FormatEnum object which is expected to contain jp2 and v properties.

sharp/lib/index.d.ts

Lines 47 to 49 in dc6820b

	declare namespace sharp {
	/** Object containing nested boolean values representing the available input and output formats/methods. */
	const format: FormatEnum;

sharp/lib/index.d.ts

Lines 1915 to 1940 in dc6820b

	interface FormatEnum {
	avif: AvailableFormatInfo;
	dcraw: AvailableFormatInfo;
	dz: AvailableFormatInfo;
	exr: AvailableFormatInfo;
	fits: AvailableFormatInfo;
	gif: AvailableFormatInfo;
	heif: AvailableFormatInfo;
	input: AvailableFormatInfo;
	jpeg: AvailableFormatInfo;
	jpg: AvailableFormatInfo;
	jp2: AvailableFormatInfo;
	jxl: AvailableFormatInfo;
	magick: AvailableFormatInfo;
	openslide: AvailableFormatInfo;
	pdf: AvailableFormatInfo;
	png: AvailableFormatInfo;
	ppm: AvailableFormatInfo;
	rad: AvailableFormatInfo;
	raw: AvailableFormatInfo;
	svg: AvailableFormatInfo;
	tiff: AvailableFormatInfo;
	tif: AvailableFormatInfo;
	v: AvailableFormatInfo;
	webp: AvailableFormatInfo;
	}

Expected

jp2 {
  id: 'jp2k',
  input: { file: false, buffer: false, stream: false },
  output: {
    file: false,
    buffer: false,
    stream: false,
    alias: [ 'j2c', 'j2k', 'jp2', 'jpx' ]
  }
}
jp2k undefined
v {
  id: 'vips',
  input: {
    file: true,
    buffer: false,
    stream: false,
    fileSuffix: [ '.v', '.vips' ]
  },
  output: { file: true, buffer: false, stream: false }
}
vips undefined

Actual

However, sharp.format returns an Object that contains jp2k and vips instead of jp2 and v. This matches the test cases that I found in this repository:

sharp/test/unit/jp2.js

Line 14 in dc6820b

if (!sharp.format.jp2k.input.buffer) {

sharp/test/unit/util.js

Lines 134 to 136 in dc6820b

	assert.strictEqual(true, sharp.format.vips[direction].file);
	assert.strictEqual(false, sharp.format.vips[direction].buffer);
	assert.strictEqual(false, sharp.format.vips[direction].stream);

jp2 undefined
jp2k {
  id: 'jp2k',
  input: { file: false, buffer: false, stream: false },
  output: {
    file: false,
    buffer: false,
    stream: false,
    alias: [ 'j2c', 'j2k', 'jp2', 'jpx' ]
  }
}
v undefined
vips {
  id: 'vips',
  input: {
    file: true,
    buffer: false,
    stream: false,
    fileSuffix: [ '.v', '.vips' ]
  },
  output: { file: true, buffer: false, stream: false }
}

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

import sharp from "sharp";

console.log("jp2", sharp.format.jp2);
console.log("jp2k", sharp.format.jp2k);

console.log("v", sharp.format.v);
console.log("vips", sharp.format.vips);

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

[lovell]

Thanks for reporting, I agree it's currently inconsistent and I'll need to think about which way we go to make it so. It'll probably be a (small) breaking change regardless.

[lovell]

Commit d161e45 ensures the TypeScript definitions for sharp.format match reality. The format.jp2k property has been renamed format.jp2 at the same time as that's more consistent with existing API e.g. the jp2 function.