MIME Types v0.1.1 MIME

Utilities for working with common MIME types.

The MIME types registry can be extended in your application configuration as follows:

config :mime_types, custom: %{
  "application/vnd.api+json" => ["json-api"]
}

After adding the configuration, the MIME module needs to be recompiled. If you are using mix, this can be accomplished with:

$ mix deps.clean mime_types --build
$ mix deps.get

Summary

Functions

extensions()

Returns a list of all known extensions associated with MIME types

extensions(type)

Returns the extensions associated with a given MIME type.

Examples

iex> MIME.extensions("text/html")
["html", "htm"]
iex> MIME.extensions("application/json")
["json"]
iex> MIME.extensions("foo/bar")
[]

mapping()

Returns a Keyword list of MIME types and their associated extensions

path(path)

Guesses the MIME type based on the path’s extension. See type/1.

Examples

iex> MIME.path("index.html")
"text/html"

type(file_extension)

Returns the MIME type associated with a file extension. If no MIME type is known for file_extension, "application/octet-stream" is returned.

Examples

iex> MIME.type("txt")
"text/plain"
iex> MIME.type("foobarbaz")
"application/octet-stream"

types()

Returns a list of all known MIME types

valid?(type)

Returns whether a MIME type is registered.

Examples

iex> MIME.valid?("text/plain")
true
iex> MIME.valid?("foo/bar")
false

Functions

extensions()

Specs

extensions :: [String.t]

Returns a list of all known extensions associated with MIME types.

extensions(type)

Specs

extensions(String.t) :: [String.t]

Returns the extensions associated with a given MIME type.

Examples

iex> MIME.extensions("text/html")
["html", "htm"]
iex> MIME.extensions("application/json")
["json"]
iex> MIME.extensions("foo/bar")
[]

mapping()

Specs

mapping :: Keyword.t

Returns a Keyword list of MIME types and their associated extensions.

path(path)

Specs

path(Path.t) :: String.t

Guesses the MIME type based on the path’s extension. See type/1.

Examples

iex> MIME.path("index.html")
"text/html"

type(file_extension)

Specs

type(String.t) :: String.t

Returns the MIME type associated with a file extension. If no MIME type is known for file_extension, "application/octet-stream" is returned.

Examples

iex> MIME.type("txt")
"text/plain"
iex> MIME.type("foobarbaz")
"application/octet-stream"

types()

Specs

types :: [String.t]

Returns a list of all known MIME types.

valid?(type)

Specs

valid?(String.t) :: boolean

Returns whether a MIME type is registered.

Examples

iex> MIME.valid?("text/plain")
true
iex> MIME.valid?("foo/bar")
false