Package Exports
- isbinaryfile
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (isbinaryfile) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
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
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
, annumber
indicating the size of the file.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
, annumber
indicating the size of the file.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");
if (isBinaryFile(process.argv[2]))
console.log("It is!")
else
console.log("No.")
fs.readFile(process.argv[2], function(err, data) {
fs.lstat(process.argv[2], function(err, stat) {
if (isBinaryFile(data, stat.size))
console.log("It is!")
else
console.log("No.")
});
});
isBinaryFile.sync(process.argv[2]); // true or false
var stat = fs.lstatSync(process.argv[2]);
isBinaryFile.sync(process.argv[2], stat.size); // true or false
Testing
Run npm install
to install mocha
, then run npm test
.