npmpackage.info

Gathering detailed insights and metrics for isbinaryfile

Other packages similar to isbinaryfile

file-is-binary

1.0.0

Returns true if a file is binary. Checks the actual contents, since extensions are not reliable. Basic wrapper for isbinaryfile to support vinyl files.

arraybuffer-isbinary

1.0.2

Detects if a file is binary in all platform. Similar to Perl's -B

@aleclarson/isbinaryfile

3.0.2

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

@c4605/interpolate-webpack-plugin

1.0.3

Inspired by [react-dev-utils/InterpolateHtmlPlugin](https://github.com/facebook/create-react-app/blob/next/packages/react-dev-utils/InterpolateHtmlPlugin.js).

Gathering detailed insights and metrics for isbinaryfile

isbinaryfile

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

5.0.4

165

MIT

TypeScript

1,224,340,849 4.2

Installations

npm install isbinaryfile

Score

99.3

Supply Chain

89.2

Quality

82.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

53

Closed

4

Merged

49

Issues

Open

5

Total

27

Closed

22

Releases

5.0.0

Published on 25 Mar 2022

4.0.0

Published on 08 Jan 2019

v3.0.1

Published on 08 Aug 2016

v3.0.0

Published on 05 Aug 2015

View all 4 releases

Developer

gjtorikian

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>= 18.0.0

Typescript Support

Yes

Node Version

20.10.0

NPM Version

10.8.1 Statistics

165 Stars

202 Commits

23 Forks

6 Watching

3 Branches

16 Contributors

Updated on 23 Oct 2024

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

1,224,340,849

Last day

-4.7%

1,125,334

Compared to previous day

Last week

2.4%

6,382,643

Compared to previous week

Last month

10.5%

26,842,338

Compared to previous month

Last year

15.6%

277,185,088

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@types/jest @types/node jest prettier release-it ts-jest tslint tslint-config-prettier typescript

Versions

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:

1const isBinaryFile = require("isbinaryfile").isBinaryFile;
2const fs = require("fs");
3
4const filename = "fixtures/pdf.pdf";
5const data = fs.readFileSync(filename);
6const stat = fs.lstatSync(filename);
7
8isBinaryFile(data, stat.size).then((result) => {
9  if (result) {
10    console.log("It is binary!")
11  }
12  else {
13    console.log("No it is not.")
14  }
15});
16
17const isBinaryFileSync = require("isbinaryfile").isBinaryFileSync;
18const bytes = fs.readFileSync(filename);
19const size = fs.lstatSync(filename).size;
20console.log(isBinaryFileSync(bytes, size)); // true or false

Testing

Run npm install, 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.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

Maintained

Determines if the project is "actively maintained".

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

Pinned-Dependencies

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

0

CII-Best-Practices

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

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

4.2

/10

Last Scanned on 2024-11-25

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