feat: allow configurable object to pass to opn

Author: niftylettuce

README.md

@@ -72,14 +72,16 @@ transport.sendMail(message).then(console.log).catch(console.error);
 
 ## Options
 
-Note that you can also pass two additional arguments to `previewEmail` function.
+Note that you can also pass three additional arguments to `previewEmail` function.
 
-These arguments are `id` and `open` (e.g. `previewEmail(message, id, open)`).
+These arguments are `id`, `open`, and `options` (e.g. `previewEmail(message, id, open, options)`).
 
 By default we automatically set an `id` using `uuid.v4()` (see [uuid][] for more info).
 
 Also, `open` is set to `true` by default - this means that we automatically open the browser for you.
 
+The `options` argument is an Object which defaults to `{ wait: false }`.  This object is passed along to [opn][]'s [options][opn-options].
+
 
 ## Contributors
 
@@ -108,3 +110,7 @@ Also, `open` is set to `true` by default - this means that we automatically open
 [uuid]: https://github.com/kelektiv/node-uuid
 
 [lad]: https://lad.js.org
+
+[opn]: https://github.com/sindresorhus/opn
+
+[opn-options]: https://github.com/sindresorhus/opn#options

package.json

@@ -11,10 +11,10 @@
     "Nick Baugh <niftylettuce@gmail.com> (http://niftylettuce.com/)"
   ],
   "dependencies": {
-    "bluebird": "^3.5.1",
-    "moment": "^2.22.2",
-    "nodemailer": "^4.6.8",
-    "opn": "^5.3.0",
+    "bluebird": "^3.5.3",
+    "moment": "^2.23.0",
+    "nodemailer": "^5.1.1",
+    "opn": "^5.4.0",
     "pug": "^2.0.3",
     "uuid": "^3.3.2"
   },
@@ -23,22 +23,22 @@
     "verbose": true
   },
   "devDependencies": {
-    "auto-bind": "^1.2.1",
-    "ava": "^0.25.0",
+    "auto-bind": "^2.0.0",
+    "ava": "^1.0.1",
     "babel-cli": "^6.26.0",
     "babel-preset-env": "^1.7.0",
-    "codecov": "^3.0.4",
+    "codecov": "^3.1.0",
     "cross-env": "^5.2.0",
-    "eslint": "^5.4.0",
-    "eslint-config-prettier": "^3.0.1",
-    "eslint-plugin-prettier": "^2.6.2",
-    "husky": "^0.14.3",
-    "lint-staged": "^7.2.2",
-    "nyc": "^12.0.2",
-    "prettier": "^1.14.2",
-    "remark-cli": "^5.0.0",
-    "remark-preset-github": "^0.0.8",
-    "xo": "^0.22.0"
+    "eslint": "^5.12.0",
+    "eslint-config-prettier": "^3.3.0",
+    "eslint-plugin-prettier": "^3.0.1",
+    "husky": "^1.3.1",
+    "lint-staged": "^8.1.0",
+    "nyc": "^13.1.0",
+    "prettier": "^1.15.3",
+    "remark-cli": "^6.0.1",
+    "remark-preset-github": "^0.0.13",
+    "xo": "^0.23.0"
   },
   "engines": {
     "node": ">=6.4.0"

src/index.js

@@ -18,7 +18,12 @@ const templateFilePath = path.join(__dirname, '..', 'template.pug');
 
 const renderFilePromise = Promise.promisify(pug.renderFile);
 
-const previewEmail = async (message, id, open = true) => {
+const previewEmail = async (
+  message,
+  id,
+  open = true,
+  options = { wait: false }
+) => {
   if (typeof message !== 'object')
     throw new Error('Message argument is required');
 
@@ -40,7 +45,7 @@ const previewEmail = async (message, id, open = true) => {
   const filePath = `${os.tmpdir()}/${id}.html`;
   await writeFile(filePath, html);
 
-  if (open) await opn(filePath, { wait: false });
+  if (open) await opn(filePath, options);
 
   return `file://${filePath}`;
 };

test/test.js

@@ -42,7 +42,7 @@ test('does not open', async t => {
 });
 
 test('invalid message', async t => {
-  const error = await t.throws(previewEmail(false));
+  const error = await t.throwsAsync(previewEmail(false));
   t.is(error.message, 'Message argument is required');
 });