242417d45d | ||
---|---|---|
.. | ||
LICENSE.txt | ||
README.md | ||
index.js | ||
package.json |
README.md
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
Much of the logic is pretty much ported from ag.
Note: if the file doesn't exist, is a directory, or is empty, the function returns false
.
Installation
npm install isbinaryfile
Usage
isBinaryFile(filepath, callback)
filepath
, astring
indicating the path to the file.callback
, afunction
for the callback. It has two arguments:err
, the typical Node.js error argumentresult
, aboolean
oftrue
orfalse
, depending on if the file is binary
isBinaryFile(bytes, size, callback)
bytes
, aBuffer
of the file's contents.size
, an optionalnumber
indicating the file size.callback
, afunction
for the callback. It has two arguments:err
, the typical Node.js error argumentresult
, aboolean
oftrue
orfalse
, depending on if the file is binary
isBinaryFile.sync(filepath)
filepath
, astring
indicating the path to the file.
isBinaryFile.sync(bytes, size)
bytes
, aBuffer
of the file's contents.size
, annumber
indicating the file size.
Returns a boolean
of true
or false
, depending on if the file is binary.
Examples
var isBinaryFile = require("isbinaryfile");
fs.readFile("some_file", function(err, data) {
fs.lstat("some_file", function(err, stat) {
isBinaryFile(data, stat.size, function (err, result) {
if (!err) {
if (result) {
console.log("It is!")
}
else {
console.log("No.")
}
}
});
});
});
isBinaryFile.sync("some_file"); // true or false
var bytes = fs.readFileSync(("some_file"));
var size = fs.lstatSync(("some_file").size;
isBinaryFile.sync(bytes, size); // true or false
Testing
Run npm install
to install mocha
, then run npm test
.