This project is part of the @thi.ng/umbrella monorepo.
650+ file extension to MIME type mappings, based on mime-db.
All MIME type mappings based on mime-db
(2021-03-26). For filesize reasons only a small selected
number
of vendor MIME types (aka */vnd.*
) are included. Most of the omitted ones are
fairly obscure anyway, so likely not problematic...
ALPHA - bleeding edge / work-in-progress
Search or submit any issues for this package
yarn add @thi.ng/mime
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/mime?module" crossorigin></script>
// UMD
<script src="https://unpkg.com/@thi.ng/mime/lib/index.umd.js" crossorigin></script>
Package sizes (gzipped, pre-treeshake): ESM: 4.94 KB / CJS: 5.00 KB / UMD: 5.11 KB
This package exposes a MIME_TYPES
object which provides
mappings from file extensions to MIME types. For each extension one or
more MIME types are provided, with the default type always in first
position.
import { MIME_TYPES } from "@thi.ng/mime";
MIME_TYPES.mp3
// [ 'audio/mpeg', 'audio/mp3' ]
MIME_TYPES.jpg
// [ 'image/jpeg' ]
MIME_TYPES.jpeg
// [ 'image/jpeg' ]
To simplify lookup and support a fallback type, the package also has
preferredType()
function:
import { preferredType } from "@thi.ng/mime";
preferredType("mp3")
// "audio/mpeg"
// unknown file extension w/ default fallback type
preferredType("foo")
// "application/octet-stream"
// unknown file extension w/ given fallback type
preferredType("foo", "text/plain")
// "text/plain"
Since v0.3.0 reverse lookups are possible too, using preferredExtension()
(also supports fallback):
preferredExtension("image/svg+xml");
// "svg"
preferredExtension("image/foo");
// "bin" (default fallback)
preferredExtension("image/foo", "dat");
// "dat" (custom fallback)
- Download the latest version of mime-db's JSON
index and
save it to
[packages/mime/]tools/mime-db.json
- Run the following command to build an up-to-date index (assumes the umbrella
repo has been pre-built already). Output will always be be written to
src/generated.ts
.
# from the thi.ng/umbrella repo root
cd packages/mime
yarn tool:convert
Additional configuration options are available in the tools/convert.ts
script.
Karsten Schmidt
If this project contributes to an academic publication, please cite it as:
@misc{thing-mime,
title = "@thi.ng/mime",
author = "Karsten Schmidt",
note = "https://thi.ng/mime",
year = 2020
}
© 2020 - 2021 Karsten Schmidt // Apache Software License 2.0