isbinaryfile

What is isbinaryfile?

The isbinaryfile npm package is used to determine if a file is binary or text. This can be useful in various scenarios such as file processing, content analysis, and data validation.

What are isbinaryfile's main functionalities?

Check if a file is binary by file path

This feature allows you to check if a file is binary by providing the file path. The function returns a promise that resolves to a boolean indicating whether the file is binary.

const { isBinaryFile } = require('isbinaryfile');

(async () => {
  const result = await isBinaryFile('path/to/file');
  console.log(result); // true or false
})();

Check if a file is binary by buffer

This feature allows you to check if a file is binary by providing a buffer. The function returns a promise that resolves to a boolean indicating whether the file is binary.

const { isBinaryFile } = require('isbinaryfile');
const fs = require('fs');

(async () => {
  const buffer = fs.readFileSync('path/to/file');
  const result = await isBinaryFile(buffer);
  console.log(result); // true or false
})();

Other packages similar to isbinaryfile

isbinaryfile

The isbinaryfile package is another option for determining if a file is binary or text. It offers similar functionality to the isbinaryfile package, allowing you to check files by path or buffer.

file-type

The file-type package can detect the file type of a buffer or stream. While it is more focused on identifying the file type rather than just determining if it is binary, it can be used to achieve similar results by checking the detected file type.

binaryextensions

The binaryextensions package provides a list of binary file extensions. While it does not directly check if a file is binary, it can be used in conjunction with file extension checks to determine if a file is likely to be binary.

README

isBinaryFile

Detects if a file is binary in Node.js. Similar to Perl's -B switch, in that:

• it reads the first few thousand bytes of a file
• checks for a null byte; if it's found, it's binary
• flags non-ASCII characters. After a certain number of "weird" characters, the file is flagged as binary

All the logic is also pretty much ported from ag.

Note: if the file doesn't exist or it is empty, this function returns false.

Installation

npm install isBinaryFile

Usage

If you pass in one argument, this module assumes it's just the file path, and performs the appropriate file read and stat functionality internally:

var isBinaryFileSync = require("isbinaryfile").isBinaryFileSync;

if (isBinaryFileSync(process.argv[2]))
	console.log("It is!")
else
	console.log("No.")

Ta da.

However, if you've already read and stat()-ed a file (for some other reason), you can pass in both the file's raw data and the stat's size info to save time:

fs.readFile(process.argv[2], function(err, data) {
	fs.lstat(process.argv[2], function(err, stat) {
		if (isBinaryFileSync(data, stat.size))
			console.log("It is!")
		else
			console.log("No.")
	});
});

Async

Previous to version 1.0.0, this program always ran in sync mode. Now, there's an async option. The async option is a method called isBinaryFile. Its callback has two arguments: err and isBinary.

The sync option is called isBinaryFileSync.

Testing

Install mocha on your machine:

npm install mocha -g

Then go into the tests directory, and type mocha test.js.

MIT License

Copyright (c) 2013 Garen J. Torikian

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.