file-type 项目使用教程

file-type 项目使用教程

file-type Detect the file type of a Buffer/Uint8Array/ArrayBuffer 项目地址: https://gitcode.com/gh_mirrors/fi/file-type

1. 项目介绍

file-type 是一个用于检测文件类型的开源项目，支持通过文件流或数据来识别文件类型。该项目通过检查文件的魔数（magic number）来确定文件类型，适用于检测二进制文件格式，如图片、视频、音频等。file-type 支持多种文件类型的检测，并且可以在 Node.js 和浏览器环境中使用。

2. 项目快速启动

安装

首先，通过 npm 安装 file-type：

npm install file-type

使用示例

在 Node.js 中检测文件类型

import { fileTypeFromFile } from 'file-type';

async function determineFileType(filePath) {
    const fileType = await fileTypeFromFile(filePath);
    console.log(fileType);
    // 输出示例: { ext: 'png', mime: 'image/png' }
}

determineFileType('Unicorn.png');

在浏览器中检测文件类型

import { fileTypeFromStream } from 'file-type';

async function determineFileTypeFromUrl(url) {
    const response = await fetch(url);
    const fileType = await fileTypeFromStream(response.body);
    console.log(fileType);
    // 输出示例: { ext: 'jpg', mime: 'image/jpeg' }
}

determineFileTypeFromUrl('https://upload.wikimedia.org/wikipedia/en/a/a9/Example.jpg');

3. 应用案例和最佳实践

应用案例

文件上传前的类型检测

在文件上传到服务器之前，可以使用 file-type 检测文件类型，以确保上传的文件符合预期格式。

import { fileTypeFromBuffer } from 'file-type';

async function checkFileType(file) {
    const buffer = await file.arrayBuffer();
    const fileType = await fileTypeFromBuffer(buffer);
    if (fileType && fileType.mime.startsWith('image/')) {
        console.log('这是一个图片文件');
    } else {
        console.log('这不是一个图片文件');
    }
}

const fileInput = document.querySelector('input[type="file"]');
fileInput.addEventListener('change', (event) => {
    const file = event.target.files[0];
    checkFileType(file);
});

最佳实践

• 使用最新版本：确保使用最新版本的 file-type，以获得最新的文件类型支持和性能优化。
• 结合其他库使用：可以结合 read-chunk 等库来读取文件的部分内容进行类型检测，以提高效率。

4. 典型生态项目

• read-chunk：用于读取文件的部分内容，常与 file-type 结合使用，以提高文件类型检测的效率。
• @tokenizer/http：用于通过 HTTP 请求获取文件的部分内容，适用于需要快速检测远程文件类型的情况。
• @tokenizer/s3：用于从 Amazon S3 存储中读取文件的部分内容，适用于云存储环境中的文件类型检测。

通过这些生态项目，file-type 可以更灵活地应用于各种场景，满足不同环境下的文件类型检测需求。

file-type Detect the file type of a Buffer/Uint8Array/ArrayBuffer 项目地址: https://gitcode.com/gh_mirrors/fi/file-type