refactor: rename options

BREAKING CHANGE: handler~> handlers, placeholder~>placeholders,mime~> mimes

README.md

@@ -72,7 +72,7 @@ map      | `map`                                             | `application/json
 
 ## Options
 
-### `handler`
+### `handlers`
 
 A mapping from file extensions to the handler. Extensions should start with *dot* like `.js`.
 
@@ -94,13 +94,13 @@ Skip middleware when no handler is defined for the current request.
 
 Please note that if this option is set to `true`, then `default` handler will be disabled!
 
-### `placeholder`
+### `placeholders`
 
 - Type: `Object`
 
 A mapping from handler to placeholder. Values can be `String` or `Buffer`. You can disable any of the placeholders by setting the value to `false`.
 
-### `mime`
+### `mimes`
 
 - Type: `Object`
 

src/defaults.js

@@ -5,7 +5,7 @@ module.exports = {
 
   skipUnknown: false,
 
-  handler: {
+  handlers: {
     // css
     '.css': 'css',
     // html
@@ -27,7 +27,7 @@ module.exports = {
     '.map': 'map'
   },
 
-  placeholder: {
+  placeholders: {
     css: '/* style not found */',
     default: undefined,
     html: '<!-- page not found -->',
@@ -37,7 +37,7 @@ module.exports = {
     map: '{"version": "3", "sources": [], "mappings": "" }'
   },
 
-  mime: {
+  mimes: {
     css: 'text/css',
     default: undefined,
     html: 'text/html',

src/index.js

@@ -15,7 +15,7 @@ module.exports = function createServePlaceholder (_options) {
     const ext = path.extname(url)
 
     // Try to find a handler based on ext
-    let handler = options.handler[ext]
+    let handler = options.handlers[ext]
 
     // Skip middleware is handler is explictly set to false
     if (handler === false) {
@@ -39,13 +39,13 @@ module.exports = function createServePlaceholder (_options) {
     }
 
     // Try to set appreciate mime type based on handler
-    const mime = options.mime[handler]
+    const mime = options.mimes[handler]
     if (mime) {
       res.setHeader('Content-Type', mime)
     }
 
     // Try to find placeholder based on handler
-    const placeholder = options.placeholder[handler]
+    const placeholder = options.placeholders[handler]
 
     // Send placeholder and end response
     res.end(placeholder)

test/basic.test.js

@@ -23,7 +23,7 @@ describe('basic', () => {
     expect(response.data).toBe('Works!')
   })
 
-  const handlersToTest = Object.entries(defaults.handler).map(([ext, handler]) => ({ ext, handler }))
+  const handlersToTest = Object.entries(defaults.handlers).map(([ext, handler]) => ({ ext, handler }))
   handlersToTest.push({ ext: '.unknown', handler: 'default ' })
 
   // Test all handlers
@@ -33,12 +33,12 @@ describe('basic', () => {
         transformResponse: req => req
       }).catch(e => e.response)
 
-      const placeholder = defaults.placeholder[handler]
+      const placeholder = defaults.placeholders[handler]
 
       if (placeholder instanceof Buffer) {
-        expect(response.data.data).toBe(defaults.placeholder[handler].data)
+        expect(response.data.data).toBe(defaults.placeholders[handler].data)
       } else {
-        expect(response.data).toBe(defaults.placeholder[handler] || '')
+        expect(response.data).toBe(defaults.placeholders[handler] || '')
       }
     })
   })

test/with-options.test.js

@@ -14,7 +14,7 @@ describe('skipUnknown', () => {
 
     app.use(placeholder({
       skipUnknown: true,
-      handler: {
+      handlers: {
         '.skipme': false
       }
     }))