v1.1.0

- Made indexPath accessible via options for more complex configuration
- Cleaned up README
- Added error messages for required params

Author: Florian Pichler

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.1.0
+
+- Made indexPath accessible via options for more complex configuration
+- Cleaned up README
+- Added error messages for required params
+
 ## 1.0.0
 
 - Initial release

README.md

@@ -35,20 +35,7 @@ app.on('ready', () => {
 
 ## API
 
-### protocolServe(cwd, options)
-
-```js
-/**
- * @param  {String} cwd                        the path to the dist folder of your Ember app
- * @param  {Object} options.app                electron.app
- * @param  {Object} options.protocol           electron.protocol
- * @param  {String} options.name               name of your protocol, defaults to `serve`
- * @param  {String} options.endpoint           endpoint of your protocol, defaults to `dist`
- * @param  {String} options.directoryIndexFile directory index. usally the default, `index.html`
- * @return {String}                            name of your protocol
- */
-```
-
+See `index.js`.
 
 
 ## Credits

index.js

@@ -1,27 +1,42 @@
 const { join } = require('path');
 const fs = require('fs');
 
+function requiredParam(param, errorMessage) {
+  if (!param) {
+    throw new Error(`electron-protocol-serve: ${errorMessage}`);
+  }
+}
+
 /**
  * Registers a file protocol with a single endpoint which handles
  * the proper discovery of local files inside of Electron
  * without modifiying the Ember app.
  *
- * @param  {String} cwd                        the path to the dist folder of your Ember app
+ * @param  {String} options.cwd                the path to the dist folder of your Ember app
  * @param  {Object} options.app                electron.app
  * @param  {Object} options.protocol           electron.protocol
  * @param  {String} options.name               name of your protocol, defaults to `serve`
  * @param  {String} options.endpoint           endpoint of your protocol, defaults to `dist`
  * @param  {String} options.directoryIndexFile directory index. usally the default, `index.html`
+ * @param  {String} options.indexPath          defaults to cwd + directoryIndexFile
+ *
  * @return {String}                            name of your protocol
  */
-module.exports = (cwd, {
+module.exports = function protocolServe({
+  cwd = undefined,
   app,
   protocol,
   name = 'serve',
   endpoint = 'dist',
   directoryIndexFile = 'index.html',
-}) => {
-  const indexPath = join(cwd, directoryIndexFile);
+  indexPath = undefined,
+}) {
+  requiredParam(cwd, 'cwd must be specified, should be a valid path');
+  requiredParam(protocol, 'protocol must be specified, should be electron.protocol');
+  requiredParam(app, 'app must be specified, should be electron.app');
+
+  indexPath = indexPath || join(cwd, directoryIndexFile);
+
   const cache = {};
   const prefixLength = name.length + 3 + endpoint.length;
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-protocol-serve",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A file protocol that serves any existing file in a directory and redirects everything not found to index.html.",
   "main": "index.js",
   "repository": "git@github.com:pichfl/electron-protocol-ember.git",