📝 Document async onWillDestroyItem behavior

This commit is contained in:
Max Brunsfeld
2017-09-12 15:15:28 -07:00
parent ed39ace4d9
commit cca04f85a3

View File

@@ -820,7 +820,8 @@ module.exports = class Workspace extends Model {
// Extended: Invoke the given callback when a pane item is about to be
// destroyed, before the user is prompted to save it.
//
// * `callback` {Function} to be called before pane items are destroyed.
// * `callback` {Function} to be called before pane items are destroyed. If this function returns
// a {Promise}, then the item will not be destroyed until the promise resolves.
// * `event` {Object} with the following keys:
// * `item` The item to be destroyed.
// * `pane` {Pane} containing the item to be destroyed.