Skip to content

jonschlinkert/file-is-binary

Repository files navigation

file-is-binary NPM version NPM monthly downloads NPM total downloads Linux Build Status

Returns true if a file is binary. Checks the actual contents, since extensions are not reliable. Basic wrapper for isbinaryfile to support vinyl files.

Install

Install with npm:

$ npm install --save file-is-binary

Usage

Uses isbinaryfile to check the file contents and return

var isBinary = require('file-is-binary');

var file = new File({path: 'foo.gif', contents: fs.readFileSync('foo.gif')});
console.log(isBinary(file));

var file = new File({path: 'bar.txt', contents: fs.readFileSync('bar.txt')});
console.log(isBinary(file));
//=> false

About

Related projects

  • file-contents: Set the contents property on a file object. Abstraction from vinyl-fs to support stream or… more | homepage
  • file-stat: Set the stat property on a file object. Abstraction from vinyl-fs to support stream or… more | homepage
  • gulp-is-binary: Adds an .isBinary() function to the file object, similar to file.isNull() and file.isStream(). | homepage

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.

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

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

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 May 19, 2017.

About

Returns true if a file is binary. Checks the actual contents, since extensions are not reliable. Basic wrapper for isbinaryfile to support vinyl files.

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published