imageProcessor.ts
tools/FileReadTool/imageProcessor.ts
95
Lines
2881
Bytes
4
Exports
2
Imports
10
Keywords
What this is
This page documents one file from the repository and includes its full source so you can read it without leaving the docs site.
Beginner explanation
This file is part of the tool layer, which means it describes actions the system can perform for the user or model.
How it is used
Start from the exports list and related files. Those are the easiest clues for where this file fits into the system.
Expert explanation
Architecturally, this file intersects with tool-system, file-tools. It contains 95 lines, 2 detected imports, and 4 detected exports.
Important relationships
Detected exports
SharpInstanceSharpFunctiongetImageProcessorgetImageCreator
Keywords
sharpsharpinstanceoptionssharpfunctionimageprocessormoduleimagebufferpromisesharpcreatorimagecreatormodule
Detected imports
buffer../../utils/bundledMode.js
Source notes
This page embeds the full file contents. Small or leaf files are still indexed honestly instead of being over-explained.
Full source
import type { Buffer } from 'buffer'
import { isInBundledMode } from '../../utils/bundledMode.js'
export type SharpInstance = {
metadata(): Promise<{ width: number; height: number; format: string }>
resize(
width: number,
height: number,
options?: { fit?: string; withoutEnlargement?: boolean },
): SharpInstance
jpeg(options?: { quality?: number }): SharpInstance
png(options?: {
compressionLevel?: number
palette?: boolean
colors?: number
}): SharpInstance
webp(options?: { quality?: number }): SharpInstance
toBuffer(): Promise<Buffer>
}
export type SharpFunction = (input: Buffer) => SharpInstance
type SharpCreatorOptions = {
create: {
width: number
height: number
channels: 3 | 4
background: { r: number; g: number; b: number }
}
}
type SharpCreator = (options: SharpCreatorOptions) => SharpInstance
let imageProcessorModule: { default: SharpFunction } | null = null
let imageCreatorModule: { default: SharpCreator } | null = null
export async function getImageProcessor(): Promise<SharpFunction> {
if (imageProcessorModule) {
return imageProcessorModule.default
}
if (isInBundledMode()) {
// Try to load the native image processor first
try {
// Use the native image processor module
const imageProcessor = await import('image-processor-napi')
const sharp = imageProcessor.sharp || imageProcessor.default
imageProcessorModule = { default: sharp }
return sharp
} catch {
// Fall back to sharp if native module is not available
// biome-ignore lint/suspicious/noConsole: intentional warning
console.warn(
'Native image processor not available, falling back to sharp',
)
}
}
// Use sharp for non-bundled builds or as fallback.
// Single structural cast: our SharpFunction is a subset of sharp's actual type surface.
const imported = (await import(
'sharp'
)) as unknown as MaybeDefault<SharpFunction>
const sharp = unwrapDefault(imported)
imageProcessorModule = { default: sharp }
return sharp
}
/**
* Get image creator for generating new images from scratch.
* Note: image-processor-napi doesn't support image creation,
* so this always uses sharp directly.
*/
export async function getImageCreator(): Promise<SharpCreator> {
if (imageCreatorModule) {
return imageCreatorModule.default
}
const imported = (await import(
'sharp'
)) as unknown as MaybeDefault<SharpCreator>
const sharp = unwrapDefault(imported)
imageCreatorModule = { default: sharp }
return sharp
}
// Dynamic import shape varies by module interop mode — ESM yields { default: fn }, CJS yields fn directly.
type MaybeDefault<T> = T | { default: T }
function unwrapDefault<T extends (...args: never[]) => unknown>(
mod: MaybeDefault<T>,
): T {
return typeof mod === 'function' ? mod : mod.default
}