素晴らしいコミュニティモジュール

マイム

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

ビルドステータス

バージョン2の注意事項

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

  • lookup()getType() lookup()名前が変更されました
  • extension()getExtension() extension()名前が変更されgetExtension()
  • charset()およびload()メソッドが削除されました

このモジュールのレガシーバージョンを使用する場合は、 npm install mime@^1ください。バージョン1のドキュメントはここにあります

インストール

NPM

1
npm install mime

Browser

コードをパッケージ化するには、 webpackbrowserifyなどのバンドラーを使用することをお勧めしますが、ブラウザー対応のバージョンは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の詳細については、以下のMime 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-typesはmime-dbの薄いラッパーで、 mime @ < v1.3.6 APIと互換性のあるAPIドロップインを提供します。

mimeは、v2の時点で、あらかじめ最適化されたバージョンのmime-dbデータセットにバンドルされている自己完結型モジュールであり、次の特性を持つ簡略化されたAPIを提供します。

  • インテリジェントに解決される型の競合(詳細については、 mime-scoreを参照)
  • 業界のベストプラクティスと一致するメソッドの命名
  • Compact footprint. Eg The minified+compressed sizes of the various modulesCompact footprint. Eg The minified+compressed sizes of the various modules
モジュールサイズ
mime-db 18 KB
mime-types mime-dbと同じ
mime 8 KB
mime/lite 2 KB

MIME 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'

複数のマップ引数が指定されている場合、各マップは、順にdefine()編集され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が返され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])

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

typeMapは、上記のnew Mimeで説明されているように、 typeMap > extensionsのマップです。

すでに別のタイプに割り当てられている内線にタイプをマップしようとした場合、デフォルトでは、このメソッドはエラーをスローします。渡す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から生成されたMarkdown RunMDロゴ