fix: make menu.popup options optional (electron#13977)

doms · ckerr · commit a7052efaf4fc · 2018-08-08T17:38:52.000-05:00
* add empty object as default param for options

* update docs

* add spec for optional options

* fix: add null check for options
diff --git a/docs/api/menu.md b/docs/api/menu.md
@@ -61,7 +61,7 @@ The `menu` object has the following instance methods:
 
 #### `menu.popup(options)`
 
-* `options` Object
+* `options` Object (optional)
   * `window` [BrowserWindow](browser-window.md) (optional) - Default is the focused window.
   * `x` Number (optional) - Default is the current mouse cursor position.
     Must be declared if `y` is declared.
diff --git a/lib/browser/api/menu.js b/lib/browser/api/menu.js
@@ -47,7 +47,7 @@ Menu.prototype._init = function () {
   this.delegate = delegate
 }
 
-Menu.prototype.popup = function (options) {
+Menu.prototype.popup = function (options = {}) {
   if (options == null || typeof options !== 'object') {
     throw new TypeError('Options must be an object')
   }
diff --git a/spec/api-menu-spec.js b/spec/api-menu-spec.js
@@ -633,10 +633,16 @@ describe('Menu module', () => {
 
     it('throws an error if options is not an object', () => {
       expect(() => {
-        menu.popup()
+        menu.popup('this is a string, not an object')
       }).to.throw(/Options must be an object/)
     })
 
+    it('allows for options to be optional', () => {
+      expect(() => {
+        menu.popup({})
+      }).to.not.throw()
+    })
+
     it('should emit menu-will-show event', (done) => {
       menu.on('menu-will-show', () => { done() })
       menu.popup({window: w})

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ Menu.prototype._init = function () {`
`47`	`47`	`this.delegate = delegate`
`48`	`48`	`}`
`49`	`49`
`50`		`-Menu.prototype.popup = function (options) {`
	`50`	`+Menu.prototype.popup = function (options = {}) {`
`51`	`51`	`if (options == null \|\| typeof options !== 'object') {`
`52`	`52`	`throw new TypeError('Options must be an object')`
`53`	`53`	`}`