Add note about false positives

terascope · Nov 1, 2024 · 427655c · 427655c
1 parent 4438556
commit 427655c
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/packages/teraslice/src/lib/utils/file_utils.ts b/packages/teraslice/src/lib/utils/file_utils.ts
@@ -170,7 +170,10 @@ export async function saveAsset(
 }
 
 /**
- * Check if a buffer contains a zip file
+ * Check if a buffer contains a zip file.
+ * Note that file extension and mime type are not checked.
+ * Any file type that is actually a zip (.xlsx, .jar, .apk,
+ * .epub) will return true.
  * @param {Buffer} buffer A buffer containing a file file
  * @returns {boolean}
  */