マイム

包括的でコンパクトな MIME タイプモジュール。

バージョン 2 の注意事項

バージョン 2 は、semver が示すように、1.x からの重大な変更です。

lookup() に改名 getType()
extension() に改名 getExtension()
charset()とload()メソッドが削除されました

このモジュールのレガシーバージョンをご希望の場合は、npm install mime@^1バージョン 1 のドキュメントがここにあります。

インストール

NPM

1
npm install mime

Browser

コードをパッケージ化するには、webpackやbrowserifyなどのバンドラーを使用することをお勧めします .ただし、ブラウザ対応バージョンは wzrd.in 経由で入手できます。たとえば、フルバージョンの場合:

1
2
3
4
<script src="https://wzrd.in/standalone/mime@latest"></script>
<script>
mime.getType(...); // etc.
<script>

または、mime/liteバージョンの場合:

1
2
3
4
<script src="https://wzrd.in/standalone/mime%2flite@latest"></script>
<script>
mimelite.getType(...); // (Note `mimelite` here)
<script>

クイックスタート

フルバージョン (800 以上の MIME タイプ、1,000 以上の拡張子) の場合:

1
2
3
4
5
const mime = require('mime');

mime.getType('txt');                    // ⇨ 'text/plain'
mime.getExtension('text/plain');        // ⇨ 'txt'

参照してくださいマイムのAPI APIの詳細については、下記を。

ライト版

このモジュールには、ベンダー固有 ( */vnd.*) および実験的 ( */x-*) タイプを省略した「ライト」バージョンもあります.フルバージョンの 8KB と比較して、約 2.5KB です。ライトバージョンをロードするには:

1
const mime = require('mime/lite');

Mime .vs. mime-types .vs. mime-db モジュール

これらの [人気のある] NPM モジュールの違いについて疑問に思っている人のために、簡単な概要を示します...

mime-db これは、MIME タイプ情報の「真実のソース」です。これは API ではなく、IANA、Apache、NGINX、および Node.js コミュニティによって提出されたカスタムマッピングからプルされた MIME タイプ定義の標準データセットです。

mime-typesAPI と互換性のある API ドロップイン (ish) を提供する mime-db の薄いラッパーmime @ < v1.3.6です。

mimev2 の時点で、mime-dbデータセットの事前最適化バージョンにバンドルされた自己完結型モジュールであり、次の特徴を持つ簡素化された API を提供します。

インテリジェントに解決されたタイプの競合 (詳細についてはmime-scoreを参照)
業界のベストプラクティスに準拠したメソッドの命名
コンパクトなフットプリント例: さまざまなモジュールの縮小 + 圧縮サイズ:

モジュール	サイズ
`mime-db`	18KB
`mime-types`	mime-db と同じ
`mime`	8KB
`mime/lite`	2KB

マイム API

どちらrequire('mime')とrequire('mime/lite')MIMEクラスのリターンのインスタンスは、以下の文書化。

new Mime(typeMap, ... more maps)

このモジュールのほとんどのユーザーは、Mime インスタンスを直接作成する必要はありませんが、カスタムマッピングを作成したい場合は、次のようにしてください...

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Require Mime class
const Mime = require('mime/Mime');

// Define mime type -> extensions map
const typeMap = {
  'text/abc': ['abc', 'alpha', 'bet'],
  'text/def': ['leppard']
};

// Create and use Mime instance
const myMime = new Mime(typeMap);
myMime.getType('abc');            // ⇨ 'text/abc'
myMime.getExtension('text/def');  // ⇨ 'leppard'

複数の map 引数を指定すると、各 map がdefine()順番に編集されます (以下を参照)。

mime.getType(pathOrExtension)

指定されたパスまたは拡張子の MIME タイプを取得します。例:

1
2
3
4
5
6
7
8
9
mime.getType('js');             // ⇨ 'application/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 拡張子が検出または認識されない場合に返されます

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

mime.getExtension(type)

指定された MIME タイプの拡張子を取得します。文字セットオプション (Content-Type ヘッダーに含まれることが多い) は無視されます。

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

mime.define(typeMap[, force = false])

[more] タイプマッピングを定義します。

typeMapnew Mime上記ので説明されているように、タイプ -> 拡張のマップです。

デフォルトでは、すでに別のタイプに割り当てられている拡張機能にタイプをマッピングしようとすると、このメソッドはエラーをスローします.引数を渡すtrueと、 forceこの動作が抑制されます (以前のマッピングをオーバーライドします)。

1
2
3
4
5
mime.define({'text/x-abc': ['abc', 'abcd']});

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

コマンドライン

1
mime [path_or_extension]

例えば

1
2
> mime scripts/jquery.js
application/javascript

から生成されたマークダウン src/README_js.md 沿って

開発ガイド

基本モジュール

組み込みオブジェクト

コミュニティモジュール

マイム