函数式 API
所有核心函数均可单独 import:
ts
import {
crop, resize, rotate, rotate90, rotate90Once, flip, filter,
watermark, applyWatermarkImage, applyTextWatermark, resolvePosition,
compress, convert, metadata, parseExif, normalizeMime,
createZip, crc32,
imgkitBatch,
embedMessage, extractMessage, steganographyCapacity,
} from 'imgkit-web';浏览器工具函数:
ts
import {
loadImage, getImageData, putImageData, createCanvas,
toBlob, toDataURL, renderText,
browserEncoder, browserTextRenderer,
} from 'imgkit-web';crop
ts
function crop(image: ImageDataLike, options: CropOptions): ImageDataLikeCropOptions:
x,y,width,height:区域裁剪aspectRatio:宽高比裁剪(与上互斥)align:宽高比模式下的对齐方式(Position)
resize
ts
function resize(image: ImageDataLike, options: ResizeOptions): ImageDataLikeResizeOptions:
width,height:目标尺寸(至少一个)fit:'exact' | 'contain' | 'cover' | 'fill'algorithm:'nearest' | 'bilinear'
rotate / flip
ts
function rotate(image: ImageDataLike, degrees: number): ImageDataLike
function rotate90(image: ImageDataLike, deg: number): ImageDataLike
function rotate90Once(image: ImageDataLike): ImageDataLike
function flip(image: ImageDataLike, axis: 'horizontal' | 'vertical'): ImageDataLikerotate 支持任意角度,画布扩展以容纳完整图像,空白区域为透明。rotate90 是 90° 整数倍的高效实现,rotate90Once 是单次 90° 顺时针旋转。
filter
ts
function filter(image: ImageDataLike, options: FilterOptions): ImageDataLikeFilterOptions 所有字段可选:
grayscale0-1sepia0-1brightness-1~1contrast-1~1blur>=0(高斯半径,可分离卷积)invert0-1opacity0-1hueRotate角度saturate0-1(1 为不变)
watermark
ts
function watermark(image, options, textRenderer?): ImageDataLike
function applyWatermarkImage(image, wmImage, options): ImageDataLike
function applyTextWatermark(image, text, options, textRenderer?): ImageDataLike
function resolvePosition(...)compress / convert
ts
async function compress(image, options): Promise<CompressResult>
async function convert(image, mimeType, quality?): Promise<Blob>compress 在指定 maxSize 时启用二分搜索:在 [0.1, quality] 范围内迭代 12 次,找最大满足体积约束的质量值。
metadata
ts
function metadata(image: ImageDataLike): ImageMetadata返回 { width, height, size, pixels, channels, averageBrightness, hasAlpha }。
parseExif
ts
function parseExif(buf: ArrayBuffer): ExifInfo从 JPEG 原始字节中解析 EXIF 元信息。返回 { orientation, make, model, dateTime, gps },非 JPEG 或无 EXIF 字段时返回空对象。
embedMessage / extractMessage / steganographyCapacity(图片隐写)
ts
function embedMessage(image: ImageDataLike, options: SteganographyEmbedOptions): SteganographyEmbedResult
function extractMessage(image: ImageDataLike, options?: SteganographyExtractOptions): SteganographyExtractResult
function steganographyCapacity(image: ImageDataLike, options?: { depth?: LsbDepth; channels?: SteganographyChannels }): number将文本信息隐藏到图片像素的最低有效位(LSB)中,肉眼不可见。支持可选的密钥加密(XOR 流加密)。
SteganographyEmbedOptions:
| 字段 | 类型 | 默认值 | 说明 |
|---|---|---|---|
message | string | — | 待嵌入的文本(必填) |
key | string | — | 加密密钥,留空则不加密 |
depth | 1 | 2 | 3 | 4 | 1 | LSB 比特深度 |
channels | SteganographyChannels | 'RGB' | 使用的颜色通道 |
SteganographyExtractOptions:
| 字段 | 类型 | 默认值 | 说明 |
|---|---|---|---|
key | string | — | 解密密钥(与嵌入时一致) |
depth | 1 | 2 | 3 | 4 | 1 | 与嵌入时一致的比特深度 |
channels | SteganographyChannels | 'RGB' | 与嵌入时一致的颜色通道 |
返回值:
embedMessage返回SteganographyEmbedResult:{ image, bitsWritten, bytesWritten, capacity }extractMessage返回SteganographyExtractResult:{ success, message, bytesRead }steganographyCapacity返回可承载的最大文本字节数(已扣除 9 字节头部开销)
数据格式:
┌──────────────┬──────────────┬──────────────┬──────────────┐
│ 魔数头(4B) │ 载荷长度(4B) │ 加密标志(1B) │ 载荷正文(NB)│
│ "IMGS" │ uint32 LE │ 0 / 1 │ UTF-8 字节 │
└──────────────┴──────────────┴──────────────┴──────────────┘示例:
ts
import { embedMessage, extractMessage, steganographyCapacity } from 'imgkit-web';
// 容量预估
const capacity = steganographyCapacity(image, { depth: 1, channels: 'RGB' });
console.log(`可嵌入 ${capacity} 字节`);
// 嵌入
const result = embedMessage(image, {
message: '这是秘密信息',
key: 'my-secret',
depth: 1,
channels: 'RGB',
});
// 提取
const extracted = extractMessage(result.image, { key: 'my-secret' });
console.log(extracted.success, extracted.message);注意:嵌入后必须以 PNG 或 WebP 无损模式输出,JPEG 等有损压缩会破坏 LSB 数据。
imgkitBatch
ts
function imgkitBatch(sources: Array<File | Blob | string | ArrayBuffer>): Promise<Pipeline[]>批量加载多张图片,返回各自独立的 Pipeline 实例数组。
ts
const pipelines = await imgkitBatch([fileA, fileB, fileC]);
pipelines[0].resize({ width: 800 });
pipelines[1].filter({ grayscale: 1 });createZip / crc32
ts
function createZip(entries: ZipEntry[]): Blob
function crc32(data: Uint8Array): numbercreateZip 将多个文件打包为 ZIP Blob,支持浏览器端下载。crc32 为 CRC-32 校验值计算。
ts
const zipBlob = createZip([
{ name: 'result-1.jpg', data: uint8Array1 },
{ name: 'result-2.png', data: uint8Array2 },
]);浏览器工具函数
ts
function loadImage(source: File | Blob | string | ArrayBuffer): Promise<HTMLImageElement>
function getImageData(source: HTMLImageElement | HTMLCanvasElement | OffscreenCanvas): ImageDataLike
function putImageData(canvas: HTMLCanvasElement | OffscreenCanvas, data: ImageDataLike): void
function createCanvas(w: number, h: number): HTMLCanvasElement | OffscreenCanvas
function toBlob(canvas: HTMLCanvasElement | OffscreenCanvas, mime: ImageMimeType, quality?: number): Promise<Blob>
function toDataURL(canvas: HTMLCanvasElement | OffscreenCanvas, mime: ImageMimeType, quality?: number): string
function renderText(text: string, options: { font: string; color: string; rotate?: number }): ImageDataLike工具函数:
ts
function createImageData(w: number, h: number): ImageDataLike
function cloneImageData(src: ImageDataLike): ImageDataLike
function getPixel(data: Uint8ClampedArray, offset: number): [number, number, number, number]
function setPixel(data: Uint8ClampedArray, offset: number, r: number, g: number, b: number, a: number): void
function packRGBA(r: number, g: number, b: number, a: number): number
function clamp(v: number, lo: number, hi: number): number
function lerp(a: number, b: number, t: number): number
function degToRad(deg: number): number
function gaussian(x: number, sigma: number): number
function gaussianKernel(sigma: number, radius: number): number[]
function binarySearchQuality(...): number