npmpackage.info

magic-bytes.js

A library for detecting file types.

1.10.0

136

MIT

TypeScript

3.80 kB

11,677,162 3.6

Installations

npm install magic-bytes.js

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

18.19.1

NPM Version

10.1.0 Score

99.5

Supply Chain

99.6

Quality

77.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

7

Total

39

Closed

6

Merged

26

Issues

Open

3

Total

21

Closed

18

Releases

v1.10.0

Published on 29 Feb 2024

v1.9.0

Published on 29 Feb 2024

v1.8.0

Published on 11 Jan 2024

v1.7.0

Published on 11 Dec 2023

v1.6.0

Published on 03 Dec 2023

v1.5.0

Published on 02 Oct 2023

View all 11 releases

Contributors

Unable to fetch Contributors

View all 14 contributors

Languages

TypeScript

HTML

CSS

JavaScript

TypeScript (87.25%)

HTML (6.97%)

CSS (3.48%)

JavaScript (2.3%)

Developer

LarsKoelpin

Download Statistics

Total Downloads

11,677,162

Last Day

23,151

Last Week

193,049

Last Month

830,267

Last Year

8,485,621

GitHub Statistics

136 Stars

213 Commits

26 Forks

1 Watching

7 Branches

14 Contributors

Bundle Size

19.04 kB

Minified

3.80 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.10.0

Package Id

magic-bytes.js@1.10.0

Unpacked Size

47.97 kB

Size

12.40 kB

File Count

NPM Version

10.1.0

Node Version

18.19.1

Publised On

29 Feb 2024

Total Downloads

Cumulative downloads

Total Downloads

11,677,162

Last day

-1.6%

23,151

Compared to previous day

Last week

-9.6%

193,049

Compared to previous week

Last month

1.5%

830,267

Compared to previous month

Last year

202.7%

8,485,621

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Magic bytes

Magic Bytes is a javascript library analyzing the first bytes of a file to tell you its type. Use it inside your browser or serversided using nodejs.

The procedure is based on https://en.wikipedia.org/wiki/List_of_file_signatures.

[!NOTE]
A small note on versioning. Strictly speaking, each new filetype which is supported by this library can break someones' API. Please note that this library adds new filetypes with minor release. This means files, which validate to "null" in some versions, may find a result in a new version.

Or in some cases the library will find more results, than before. So don't depend on the found-array size in any shape or form. Filetypes will not be remoevd tho

Installation

Run npm install magic-bytes.js

Interactive example

There is an interactive example present at https://larskoelpin.github.io/magic-bytes/.

Usage

The following functions are available:

filetypeinfo(bytes: number[]) Contains typeinformation like name, extension and mime type: [{typename: "zip"}, {typename: "jar"}]
filetypename(bytes: number[]) : Contains type names only: ["zip", "jar"]
filetypemime(bytes: number[]) : Contains type mime types only: ["application/zip", "application/jar"]
filetypeextension(bytes: number[]) : Contains type extensions only: ["zip", "jar"]

Both function return an empty array [] otherwise, which means it could not detect the file signature. Keep in mind that txt files for example fall in this category.

You don't have to load the whole file in memory. For validating a file uploaded to S3 using Lambda for example, it may be
enough to load the files first 100 bytes and validate against them. This is especially useful for big files.

see examples for practical usage.

On server:

1import filetype from 'magic-bytes.js'
2
3filetype(fs.readFileSync("myimage.png")) // ["png"]

To run an HTML-Example checkout the project and run

npm install; npm run example

This opens an HTML example using magic bytes as a window variable. It kinda looks like that.

1<input type="file" id="file" />
2
3 <script src="node_modules/magic-bytes.js/dist/browser.js" type="application/javascript"></script>
4<script>
5    document.getElementById("file").addEventListener('change', (event, x) => {
6      const fileReader = new FileReader();
7      fileReader.onloadend = (f) => {
8        const bytes = new Uint8Array(f.target.result);
9        console.log("Possible filetypes: " + filetypeinfo(bytes))
10      }
11      fileReader.readAsArrayBuffer(event.target.files[0])
12    })
13</script>

Tests

Run npm test

Example

See examples/

How does it work

The create-snapshot.js creates a new tree. The tree has a similar shape to the following

1{
2  "0x47": {
3    "0x49": {
4      "0x46": {
5        "0x38": {
6          "0x37": {
7            "0x61": {
8              "matches": [
9                {
10                  "typename": "gif",
11                  "mime": "image/gif",
12                  "extension": "gif"
13                }
14              ]
15            }
16          },
17        }
18      }
19    }
20  }
21}

It acts as a giant lookup map for the given byte signatures.

No vulnerabilities found.

10

Binary-Artifacts

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

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

Token-Permissions

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

2

Pinned-Dependencies

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

1

Code-Review

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

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

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.6

/10

Last Scanned on 2025-01-20

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

Other packages similar to magic-bytes.js

@labelbox/magic-bytes.js

1.0.15

Detect Filetype by bytes

image-mime

0.0.2

image mime

magic-bytes.js

Installations

Developer Guide

Yes

CommonJS

18.19.1

10.1.0

Score

Pull Requests

7

39

6

26

Issues

3

21

18

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

LarsKoelpin

Download Statistics

GitHub Statistics

Bundle Size

19.04 kB

3.80 kB

Maintainers

Package Meta Information

Total Downloads

11,677,162

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

Magic bytes

Installation

Interactive example

Usage

Tests

Example

How does it work

10

10

10

9

2

1

0

0

0

0

0

0

0

3.6

/10

Other packages similar to magic-bytes.js