athea
Repositories Projects Packages

isbinaryfile (4.0.10)

Published 2026-02-24 13:58:48 +00:00 by atheaadmin

Installation

registry=
npm install isbinaryfile@4.0.10
"isbinaryfile": "4.0.10"

About this package

isBinaryFile

Detects if a file is binary in Node.js using ✨promises✨. 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 or is a directory, an error is thrown.

Installation

npm install isbinaryfile

Usage

Returns Promise<boolean> (or just boolean for *Sync). true if the file is binary, false otherwise.

isBinaryFile(filepath)

  • filepath - a string indicating the path to the file.

isBinaryFile(bytes[, size])

  • bytes - a Buffer of the file's contents.
  • size - an optional number indicating the file size.

isBinaryFileSync(filepath)

  • filepath - a string indicating the path to the file.

isBinaryFileSync(bytes[, size])

  • bytes - a Buffer of the file's contents.
  • size - an optional number indicating the file size.

Examples

Here's an arbitrary usage:

const isBinaryFile = require("isbinaryfile").isBinaryFile;
const fs = require("fs");

const filename = "fixtures/pdf.pdf";
const data = fs.readFileSync(filename);
const stat = fs.lstatSync(filename);

isBinaryFile(data, stat.size).then((result) => {
  if (result) {
    console.log("It is binary!")
  }
  else {
    console.log("No it is not.")
  }
});

const isBinaryFileSync = require("isbinaryfile").isBinaryFileSync;
const bytes = fs.readFileSync(filename);
const size = fs.lstatSync(filename).size;
console.log(isBinaryFileSync(bytes, size)); // true or false

Testing

Run npm install, then run npm test.

Dependencies

Development Dependencies

ID Version
@types/jest ^23.3.14
@types/node ^10.17.59
jest ^26.5.5
prettier ^1.19.1
release-it ^14.13.1
ts-jest ^26.5.5
tslint ^5.20.1
tslint-config-prettier ^1.18.0
typescript ^3.9.9

Keywords

text binary encoding istext is text isbinary is binary is text or binary is text or binary file isbinaryfile is binary file istextfile is text file
Details
npm
2026-02-24 13:58:48 +00:00
1
Project Site
MIT
latest
4.3 KiB
Assets (1)
isbinaryfile-4.0.10.tgz 4.3 KiB
Versions (1) View all
4.0.10 2026-02-24