File.image method | globals module | Bun

Wrap this blob in a Bun.Image pipeline. Equivalent to new Bun.Image(this, options) — the constructor is synchronous (the underlying read happens lazily when an Image terminal is awaited), so this works on Bun.file(), Bun.s3(), fd-backed and in-memory blobs alike:

await Bun.file("photo.jpg").image().resize(400).webp().write("thumb.webp");

Apply EXIF Orientation (JPEG) before any other operation.

Reject inputs whose width × height exceeds this many pixels. The check runs after the header is read but before any pixel buffer is allocated, so a tiny file claiming a huge canvas is refused cheaply.

Apply EXIF Orientation (JPEG) before any other operation.

Reject inputs whose width × height exceeds this many pixels. The check runs after the header is read but before any pixel buffer is allocated, so a tiny file claiming a huge canvas is refused cheaply.

Multiplier; 1 leaves brightness unchanged.

0 = greyscale, 1 = unchanged, >1 = more saturated.

Resampling kernel.

"fill" stretches to exactly width×height. "inside" preserves aspect ratio so the result fits within width×height.

Never upscale — if the source is already smaller, leave it.

Stable error.code values set on rejections from Bun.Image terminals. Branch on these instead of parsing the message.

bmp/tiff/gif are decode-only — metadata().format may report them but there are no .bmp()/.tiff()/.gif() encoder methods. tiff decode rejects with error.code === "ERR_IMAGE_FORMAT_UNSUPPORTED" on Linux; gif decodes the first frame everywhere.