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

マイム

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

ビルドステータス

バージョン2の注意事項

バージョン2は、semverが示すように、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 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 @ < v1.3.6 APIと互換性のあるAPIドロップイン(ish)を提供するmime-dbの薄いラッパーです。

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'

複数の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が返されnull

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

mime.getExtension(type)

指定されたmimeタイプの拡張子を取得します。Charsetオプション(多くの場合、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に記載されているように、タイプ->拡張機能のマップです。

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