README
Check the image file of a Buffer/Uint8Array that matched expected image MIME-type.
This library check the file content instead of file extensions using following:
- sindresorhus/image-type: Detect the image type of a Buffer/Uint8Array
- sindresorhus/is-svg: Check if a string or buffer is SVG
Install
Install with npm:
npm install validate-image-type
Usage
import { validateMIMEType } from "validate-image-type";
const result = validateMIMEType("./image.png", {
allowMimeTypes: ['image/jpeg', 'image/gif', 'image/png', 'image/svg+xml']
});
if (!result.ok) {
console.error(result.error);
return;
}
console.log("This image is valid");
See following document about MimeType.
Supported file types
Basic images file types and SVG(image/svg+xml
).
See image-type
's Supported file types
Examples
Integration with Multer middleware.
const multer = require('multer');
const temp_local_img_dir = path.join(__dirname, `/.temp_local_img_dir`);
const upload = multer({ dest: temp_local_img_dir });
app.post(
'/upload',
upload.single('image'),
wrap(async (req, res, next) => {
const validationResult = validateMIMEType(req.file.path, {
originalFilename: req.file.originalname,
allowMimeTypes: ['image/jpeg', 'image/gif', 'image/png', 'image/svg+xml'],
});
console.log('validationResult', validationResult);
if (!validationResult.ok) {
return res.send(400);
}
// uploading task
}),
);
Changelog
See Releases page.
Running tests
Install devDependencies and Run npm test
:
npm test
Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Author
License
MIT © azu