Mime package in Nitro codebase.

#server #nitro #mime #opensource

In this article, we review how Mime package is used in Nitro codebase. We will look at:

What is Mime package?
mime.getType in Nitro codebase.

I study patterns used in an open source project found on Github Trending. For this week, I reviewed some parts of Nitro codebase and wrote this article.

What is Mime package?

Mime provides an API for MIME type information.

Installation

npm install mime

Quick start

import mime from 'mime';

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

For a comprehensive list of API, checkout Mime documentation.

mime.getType in Nitro codebase.

In nitro/src/prerender/prerender.ts, you will find the following import:

import mime from "mime";

and this is used as shown below at L287:

// Allow overriding content-type in `prerender:generate` hook
const inferredContentType = mime.getType(_route.fileName) || "text/plain";

Here mime.getType is used. In the documentation, I found this below information:

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'