Sharp Adapter

Use the optional subexport @huh-david/bmp-js/sharp to bridge BMP data into Sharp without manual format juggling.

Install

pnpm add sharp

sharp is optional for the core package and only needed when you use this adapter.

API

• isBmp(input)
• decodeForSharp(input)
• toSharpInput(input) (compatibility alias of decodeForSharp)
• sharpFromBmp(input, sharpModule?)
• sharpFromBmp({ input, sharp })
• encodeFromSharp({ data, info }, options?)
• encodeFromSharp({ data, width, height, channels }, options?)
• encodeFromSharp(data, info, options?)

BMP -> Sharp -> PNG

import sharp from "sharp";
import { sharpFromBmp } from "@huh-david/bmp-js/sharp";

const png = await sharpFromBmp(bmpBytes, sharp).resize(800).png().toBuffer();

Sharp raw -> BMP

import sharp from "sharp";
import { encodeFromSharp } from "@huh-david/bmp-js/sharp";

const { data, info } = await sharp(input).ensureAlpha().raw().toBuffer({ resolveWithObject: true });

const bmp = encodeFromSharp({ data, info }, { bitDepth: 32 });

Behavior

• Adapter decode output is normalized to RGBA and raw.channels = 4.
• decodeForSharp returns raw and info aliases for Sharp ergonomics.
• encodeFromSharp supports channels 3 and 4 only.
• Default encode depth is data-preserving:
  • channels=3 -> 24-bit
  • channels=4 -> 32-bit
• Non-BMP input to decode helpers throws a clear error.