mimos
Advanced tools
Comparing version 3.0.3 to 3.1.1
'use strict'; | ||
// Load modules | ||
const Path = require('path'); | ||
const Path = require('path'); | ||
const Hoek = require('hoek'); | ||
const MimeDb = require('mime-db'); | ||
const MimeDb = require('mime-db/db.json'); // Load JSON file to prevent loading or executing code | ||
// Declare internals | ||
const internals = {}; | ||
@@ -16,2 +13,4 @@ | ||
internals.compressibleRx = /^text\/|\+json$|\+text$|\+xml$/; | ||
internals.compile = function (override) { | ||
@@ -49,2 +48,3 @@ | ||
module.exports = class Mimos { | ||
constructor(options) { | ||
@@ -74,3 +74,3 @@ | ||
mime = { | ||
type: type, | ||
type, | ||
source: 'mimos', | ||
@@ -93,2 +93,3 @@ extensions: [], | ||
internals.base = internals.compile(); // Prevents an expensive copy on each constructor when no customization is needed |
{ | ||
"name": "mimos", | ||
"description": "Mime database interface", | ||
"version": "3.0.3", | ||
"version": "3.1.1", | ||
"repository": "git://github.com/hapijs/mimos", | ||
"engines": { | ||
"node": ">=6.0.0" | ||
}, | ||
"main": "lib/index.js", | ||
@@ -12,5 +15,2 @@ "keywords": [ | ||
], | ||
"engines": { | ||
"node": ">=4.0.0" | ||
}, | ||
"dependencies": { | ||
@@ -21,9 +21,9 @@ "hoek": "4.x.x", | ||
"devDependencies": { | ||
"code": "3.x.x", | ||
"lab": "10.x.x" | ||
"code": "4.x.x", | ||
"lab": "14.x.x" | ||
}, | ||
"scripts": { | ||
"test": "lab -m 5000 -t 100 -v -La code" | ||
"test": "lab -m 5000 -t 100 -L -a code -l" | ||
}, | ||
"license": "BSD-3-Clause" | ||
"license": "SEE LICENSE IN LICENSE.md" | ||
} |
141
README.md
@@ -1,142 +0,9 @@ | ||
#mimos | ||
# mimos | ||
Mime database interface. | ||
[![Build Status](https://secure.travis-ci.org/hapijs/mimos.svg)](http://travis-ci.org/hapijs/mimos) | ||
[![Current Version](https://img.shields.io/npm/v/mimos.svg)](https://www.npmjs.com/package/mimos) | ||
Lead Maintainer - [Adam Bretz](https://github.com/arb) | ||
Mimos is a convenience class for retrieving mime information objects. | ||
## Usage | ||
[![Build Status](https://travis-ci.org/hapijs/mimos.svg?branch=v3-commercial)](https://travis-ci.org/hapijs/mimos) | ||
### `new Mimos([options])` | ||
## License | ||
Creates a new Mimos object where: | ||
- `[options]` - an option object the following keys | ||
- `[override]` - an object hash that is merged into the built in mime information specified [here](https://github.com/jshttp/mime-db). Each key value pair represents a single mime object. Each override value should follow this schema: | ||
- `key` - the key is the lower-cased correct mime-type. (Ex. "application/javascript"). | ||
- `value` - the value should an object following the specifications outlined [here](https://github.com/jshttp/mime-db#data-structure). Additional values include: | ||
- `type` - specify the `type` value of result objects, defaults to `key`. See the example below for more clarification. | ||
- `predicate` - method with signature `function(mime)` when this mime type is found in the database, this function will run. This allows you make customizations to `mime` based on developer criteria. | ||
### `mimos.path(path)` | ||
Returns mime object where: | ||
- `path` path to file including the file extension. Uses the `extension` values of the mime objects for lookup. | ||
```js | ||
const mimos = new Mimos(); | ||
const mime = mimos.path('/static/public/app.js'); | ||
// mime | ||
/* | ||
{ | ||
source: 'iana', | ||
charset: 'UTF-8', | ||
compressible: true, | ||
extensions: [ 'js' ], | ||
type: 'application/javascript' | ||
} | ||
*/ | ||
``` | ||
### `mimos.type(type)` | ||
Returns mime object where: | ||
- `type` the content-type to find mime information about. Uses the `type` values of the mime objects for lookup. | ||
```js | ||
const mimos = new Mimos(); | ||
const mime = mimos.type('text/plain'); | ||
// mime | ||
/* | ||
{ | ||
source: 'iana', | ||
compressible: true, | ||
extensions: ['txt', 'text', 'conf', 'def', 'list', 'log', 'in', 'ini'], | ||
type: 'text/plain' | ||
} | ||
*/ | ||
``` | ||
### Override Example | ||
In certain situations, it can be helpful to override the built in mime type information. The optional argument to the Mimos constructor is used to override and add mime information. Below is an example to help understand how this works. | ||
```js | ||
const options = { | ||
override: { | ||
'node/module': { | ||
source: 'iana', | ||
compressible: true, | ||
extensions: ['node', 'module', 'npm'], | ||
type: 'node/module' | ||
}, | ||
'application/javascript': { | ||
source: 'iana', | ||
charset: 'UTF-8', | ||
compressible: true, | ||
extensions: ['js', 'javascript'], | ||
type: 'text/javascript' | ||
}, | ||
'text/html': { | ||
predicate: function(mime) { | ||
if (someCondition) { | ||
mime.foo = 'test'; | ||
} | ||
else { | ||
mime.foo = 'bar'; | ||
} | ||
return mime; | ||
} | ||
} | ||
} | ||
} | ||
const mimos = new Mimos(options); | ||
console.dir(mimos.path('./node_modules/mimos.module')); | ||
/* | ||
{ | ||
source: 'iana', | ||
compressible: true, | ||
extensions: ['node', 'module', 'npm'], | ||
type: 'node/module' | ||
} | ||
*/ | ||
console.dir(mimos.type('application/javascript')); | ||
/* | ||
Note: even though we asked for type 'application/javascript', the type value is 'text/javascript' because of the override. Always use the proper content-type for retrieval. | ||
{ | ||
source: 'iana', | ||
charset: 'UTF-8', | ||
compressible: true, | ||
extensions: ['js', 'javascript'], | ||
type: 'text/javascript' | ||
} | ||
*/ | ||
console.dir(mimos.type('text/html')); | ||
/* | ||
someCondition is true: | ||
{ | ||
source: 'iana', | ||
compressible: true, | ||
extensions: ['html','htm'], | ||
type: 'test/html', | ||
foo: 'test' | ||
} | ||
someCondition is false: | ||
{ | ||
source: 'iana', | ||
compressible: true, | ||
extensions: ['html','htm'], | ||
type: 'test/html', | ||
foo: 'bar' | ||
} | ||
*/ | ||
``` | ||
This version of the package requires a commercial license. You may not use, copy, or distribute it without first acquiring a commercial license from Sideway Inc. Using this software without a license is a violation of US and international law. To obtain a license, please contact [sales@sideway.com](mailto:sales@sideway.com). The open source version of this package can be found [here](https://github.com/hapijs/mimos). |
Sorry, the diff of this file is not supported yet
Deprecated
MaintenanceThe maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
SPDX disjunction
LicenseSPDX disjunction for an artifact's license information
Found 1 instance in 1 package
Non-permissive License
License(Experimental) A license not known to be considered permissive was found
Found 1 instance in 1 package
Unidentified License
License(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license
Found 1 instance in 1 package
Deprecated
MaintenanceThe maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.
Found 1 instance in 1 package
SPDX disjunction
LicenseSPDX disjunction for an artifact's license information
Found 1 instance in 1 package
Unidentified License
License(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license
Found 1 instance in 1 package
4217
3
64
9
1