Installations

npm install @aleclarson/isbinaryfile

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=0.6.0

Node Version

10.7.0

NPM Version

6.1.0 Pull Requests

Open

0

Total

53

Closed

4

Merged

49

Issues

Open

5

Total

27

Closed

22

Releases

4

5.0.0

Updated on Mar 25, 2022

4.0.0

Updated on Jan 08, 2019

v3.0.1

Updated on Aug 08, 2016

v3.0.0

Updated on Aug 05, 2015

View All 4 releases

Languages

1

TypeScript

TypeScript (100%)

Developer

gjtorikian

Download Statistics

Total Downloads

768

Last Day

1

Last Week

1

Last Month

10

Last Year

123

GitHub Statistics

MIT License

167 Stars

202 Commits

24 Forks

5 Watchers

3 Branches

16 Contributors

Updated on Jul 04, 2025

Bundle Size

3.12 kB

Minified

1.20 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

View All 16 Contributors

Package Meta Information

Latest Version

3.0.2

Package Id

@aleclarson/isbinaryfile@3.0.2

Unpacked Size

7.27 kB

Size

2.88 kB

File Count

4

NPM Version

6.1.0

Node Version

10.7.0

Total Downloads

Cumulative downloads

Total Downloads

768

Last Day

0%

1

Compared to previous day

Last Week

0%

1

Compared to previous week

Last Month

11.1%

10

Compared to previous month

Last Year

12.8%

123

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

buffer-alloc

Dev Dependencies

5

mocha grunt grunt-release grunt-exec grunt-cli

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, a string indicating the path to the file.
callback, a function for the callback. It has two arguments:
- err, the typical Node.js error argument
- result, a boolean of true or false, depending on if the file is binary

isBinaryFile(bytes, size, callback)

bytes, a Buffer of the file's contents.
size, an optional number indicating the file size.
callback, a function for the callback. It has two arguments:
- err, the typical Node.js error argument
- result, a boolean of true or false, depending on if the file is binary

isBinaryFile.sync(filepath)

filepath, a string indicating the path to the file.

isBinaryFile.sync(bytes, size)

bytes, a Buffer of the file's contents.
size, an number indicating the file size.

Returns a boolean of true or false, depending on if the file is binary.

Examples

1var isBinaryFile = require("isbinaryfile");
2
3fs.readFile("some_file", function(err, data) {
4  fs.lstat("some_file", function(err, stat) {
5    isBinaryFile(data, stat.size, function (err, result) {
6      if (!err) {
7        if (result) {
8          console.log("It is!")
9        }
10        else {
11          console.log("No.")
12        }
13      }
14    });
15  });
16});
17
18isBinaryFile.sync("some_file"); // true or false
19var bytes = fs.readFileSync(("some_file"));
20var size = fs.lstatSync(("some_file").size;
21isBinaryFile.sync(bytes, size); // true or false

Testing

Run npm install to install mocha, then run npm test.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

9

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

3

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

3.2

/10

Last Scanned on 2025-06-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More