The failOn option is a critical configuration parameter in , the high-performance Node.js image processing library. It determines how the underlying libvips engine responds to corrupted or truncated image data during the decoding process. Core Functionality
: In professional workflows, you may prefer an explicit error over a "successfully" processed image that has visual artifacts or missing color profiles. Setting failOn to warning ensures that only high-quality, valid assets enter your storage.
When configuring failOn , you typically choose between different severity levels. While specific implementations can vary based on your version of Sharp or the wrapper (like Directus ), the logic generally follows these tiers:
The failOn setting only takes effect after the image format is identified. If the first few "magic bytes" of a file (e.g., the PNG header) are missing or wrong, sharp will throw an "unsupported image format" error before failOn can be applied. sharp failon option
Below are the methods to implement "fail on" logic.
To force a failure on truncated images, check the info object returned after processing.
// Sharp specific flag for incomplete data if (info.truncated) throw new Error('Image is truncated (incomplete data)'); The failOn option is a critical configuration parameter
The failOn option controls the for image loading errors. It allows developers to decide whether to process a "best-effort" version of a damaged image or to reject it entirely to ensure data integrity. Sensitivity 'none'
async function rejectSmallImages(input)
return data; catch (err) console.error('Failed strict check:', err.message); throw err; Setting failOn to warning ensures that only high-quality,
Note: If "sharp failon option" refers to a specific CLI tool or a different software library not mentioned here, please provide additional context regarding the technology stack.
Always use async/await to ensure the process fails and stops if the input is not a valid image.