Skip to content

Returns true if a file appears to be a corrupted jpeg image file and is corrupted.

License

Notifications You must be signed in to change notification settings

johno/is-corrupted-jpeg

 
 

Repository files navigation

is-corrupted-jpeg NPM version NPM monthly downloads NPM total downloads Linux Build Status

Returns true if a file appears to be a corrupted jpeg image file and is corrupted.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save is-corrupted-jpeg

How reliable is this?

This will not be correct 100% of the time. This library only returns true when the jpeg's dimensions are undefined. However, it's possible for a jpeg to be corrupted whilst still having readble dimensions.

Usage

Takes a filepath to a .jpg or .jpeg file (case insensitive).

var isCorrupted = require('is-corrupted-jpeg');
console.log(isCorrupted('./path/to/image/not-corrupted.jpg'));
//=> true
console.log(isCorrupted('./path/to/image/corrupted.jpg'));
//=> false

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

  • fs-utils: fs extras and utilities to extend the node.js file system module. Used in Assemble and… more | homepage
  • is-glob: Returns true if the given string looks like a glob pattern or an extglob pattern… more | homepage
  • micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | homepage

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on November 02, 2017.

About

Returns true if a file appears to be a corrupted jpeg image file and is corrupted.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%