Mime 项目技术文档

1. 安装指南

1.1 安装环境要求

• 需要 Node.js 环境，建议使用 Node.js 14.x 或更高版本。
• 需要支持 ESM 模块的运行时环境。
• 需要支持 ES2020 或更高版本的 JavaScript 运行时。

1.2 安装步骤

通过 npm 安装 mime 包：

npm install mime

2. 项目的使用说明

2.1 快速开始

安装完成后，可以通过以下代码快速使用 mime 模块：

import mime from 'mime';

// 获取文件扩展名对应的 MIME 类型
mime.getType('txt');                    // ⇨ 'text/plain'

// 获取 MIME 类型对应的文件扩展名
mime.getExtension('text/plain');        // ⇨ 'txt'

2.2 Lite 版本

mime/lite 是 mime 的精简版本，去除了非官方的 MIME 类型（如 prs.*、x-*、vnd.*）。可以通过以下方式导入：

import mime from 'mime/lite';

3. 项目 API 使用文档

3.1 mime.getType(pathOrExtension)

获取给定文件路径或扩展名对应的 MIME 类型。

mime.getType('js');             // ⇨ 'text/javascript'
mime.getType('json');           // ⇨ 'application/json'
mime.getType('txt');            // ⇨ 'text/plain'
mime.getType('dir/text.txt');   // ⇨ 'text/plain'
mime.getType('dir\\text.txt');  // ⇨ 'text/plain'
mime.getType('.text.txt');      // ⇨ 'text/plain'
mime.getType('.txt');           // ⇨ 'text/plain'

如果扩展名未被识别，返回 null：

mime.getType('foo/txt');        // ⇨ null
mime.getType('bogus_type');     // ⇨ null

3.2 mime.getExtension(type)

获取给定 MIME 类型对应的文件扩展名。忽略字符集选项（通常包含在 Content-Type 头中）。

mime.getExtension('text/plain');               // ⇨ 'txt'
mime.getExtension('application/json');         // ⇨ 'json'
mime.getExtension('text/html; charset=utf8');  // ⇨ 'html'

3.3 mime.getAllExtensions(type)

获取给定 MIME 类型的所有文件扩展名。

mime.getAllExtensions('image/jpeg'); // ⇨ Set(3) { 'jpeg', 'jpg', 'jpe' }

4. 项目安装方式

4.1 通过 npm 安装

npm install mime

4.2 自定义 Mime 实例

可以通过以下方式创建自定义的 Mime 实例：

import { Mime } from 'mime/lite';
import standardTypes from 'mime/types/standard.js';
import otherTypes from 'mime/types/other.js';

const mime = new Mime(standardTypes, otherTypes);

4.3 定义自定义 MIME 类型

可以通过 mime.define() 方法定义自定义的 MIME 类型映射：

mime.define({'text/x-abc': ['abc', 'abcd']});

mime.getType('abcd');            // ⇨ 'text/x-abc'
mime.getExtension('text/x-abc')  // ⇨ 'abc'

5. 命令行使用

5.1 扩展名 -> MIME 类型

$ mime scripts/jquery.js
text/javascript

5.2 MIME 类型 -> 扩展名

$ mime -r image/jpeg
jpeg

通过以上文档，您可以轻松安装、使用和扩展 mime 项目，满足不同场景下的 MIME 类型处理需求。