From e4450c8417624b71d779cb4f41692538f9165e10 Mon Sep 17 00:00:00 2001
From: sowgro <tpoke.ferrari@gmail.com>
Date: Sat, 2 Sep 2023 19:12:47 -0400
Subject: first commit

---
 node_modules/magic-bytes.js/README.md | 92 +++++++++++++++++++++++++++++++++++
 1 file changed, 92 insertions(+)
 create mode 100644 node_modules/magic-bytes.js/README.md

(limited to 'node_modules/magic-bytes.js/README.md')

diff --git a/node_modules/magic-bytes.js/README.md b/node_modules/magic-bytes.js/README.md
new file mode 100644
index 0000000..9428b95
--- /dev/null
+++ b/node_modules/magic-bytes.js/README.md
@@ -0,0 +1,92 @@
+# Magic bytes
+
+[![Build Status](https://travis-ci.org/LarsKoelpin/magic-bytes.svg?branch=master)](https://travis-ci.org/LarsKoelpin/magic-bytes)
+
+
+Magic Bytes is a javascript library analyzing the first bytes of a file to tell you its type. The procedure
+is based on https://en.wikipedia.org/wiki/List_of_file_signatures.
+
+# Installation
+Run `npm install magic-bytes.js`
+
+# Usage
+On server:
+```javascript
+import filetype from 'magic-bytes.js'
+
+filetype(fs.readFileSync("myimage.png")) // ["png"]
+```
+
+Using HTML:
+```html
+<input type="file" id="file" />
+
+ <script src="node_modules/magic-bytes.js/dist/browser.js" type="application/javascript"></script>
+<script>
+    document.getElementById("file").addEventListener('change', (event, x) => {
+      const fileReader = new FileReader();
+      fileReader.onloadend = (f) => {
+        const bytes = new Uint8Array(f.target.result);
+        console.log("Possible filetypes: " + filetypeinfo(bytes))
+      }
+      fileReader.readAsArrayBuffer(event.target.files[0])
+    })
+</script>
+```
+
+# API
+The following functions are availble:
+* `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.
+
+# 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 
+```json
+{
+  "0x47": {
+    "0x49": {
+      "0x46": {
+        "0x38": {
+          "0x37": {
+            "0x61": {
+              "matches": [
+                {
+                  "typename": "gif",
+                  "mime": "image/gif",
+                  "extension": "gif"
+                }
+              ]
+            }
+          },
+        }
+      }
+    }
+  }
+}
+```
+
+It acts as a giant lookup map for the given byte signatures. To check all available entries, have a look at `pattern-tree.js` and its
+generated `pattern-tree.snapshot`, which acts as a static resource.
+
+# Supported types
+Please refer to  `src/pattern-tree.js`
+
+# Roadmap
+* Specialize type detection(like zip) using offset-subtrees
+* Add encoding detection
-- 
cgit v1.2.3