Argument	Description
`callback`	Function to be called whenever ::beep is called.

Return values
Returns a Disposable on which `.dispose()` can be called to unsubscribe.

Argument	Description
`callback`	Function to be called whenever there is an unhandled error
`event`	Object
`originalError`	Object the original error object
`message`	String the original error object
`url`	String Url to the file where the error originated.
`line`	Number
`column`	Number
`preventDefault`	Function call this to avoid popping up the dev tools.

Return values
Returns a Disposable on which `.dispose()` can be called to unsubscribe.

Argument	Description
`callback`	Function to be called whenever there is an unhandled error
`event`	Object
`originalError`	Object the original error object
`message`	String the original error object
`url`	String Url to the file where the error originated.
`line`	Number
`column`	Number

Return values
Returns a Disposable on which `.dispose()` can be called to unsubscribe.

Argument	Description
`callback`	Function to be called whenever there is an unhandled error

Return values
Returns a Boolean that is `true` if the current window is in development mode.

Return values
Returns a Boolean that is `true` if the current window is in safe mode.

Return values
Returns a Boolean that is `true` if the current window is running specs.

Return values
Returns the app name String.

Return values
Returns the version text String.

Return values
Returns the release channel as a String. Will return a specific release channel name like ‘beta’ or ‘nightly’ if one is found in the Atom version or ‘stable’ otherwise.

Return values
Returns a Boolean that is `true` if the current version is an official release.

Return values
Returns the Number of milliseconds taken to load the window or null if the window hasn’t finished loading yet.

Return values
Returns an array of timing markers. Each timing is an object with two keys: `label`: string `time`: Time since the `startTime` (in milliseconds).

Return values
Returns an Object containing all the load setting key/value pairs.

Argument	Description
`params`	An Object with the following keys:
`pathsToOpen`	An Array of String paths to open.
`newWindow`	A Boolean, true to always open a new window instead of reusing existing windows depending on the paths to open.
`devMode`	A Boolean, true to open the window in development mode. Development mode loads the Atom source from the locally cloned repository and also loads all the packages in ~/.atom/dev/packages
`safeMode`	A Boolean, true to open the window in safe mode. Safe mode prevents all packages installed to ~/.atom/packages from loading.

Return values
Returns an Object in the format `{width: 1000, height: 700}`

Argument	Description
`width`	The Number of pixels.
`height`	The Number of pixels.

Return values
Returns an Object in the format `{x: 10, y: 20}`

Argument	Description
`x`	The Number of pixels.
`y`	The Number of pixels.

Argument	Description
`callback`	A Function to call once the user has confirmed the selection.
`paths`	An Array of String paths that the user selected, or `null` if the user dismissed the dialog.

Return values
Returns a Boolean that is `true` if the current window is maximized.

Return values
Returns a Boolean that is `true` if the current window is in full screen mode.

A flexible way to open a dialog akin to an alert dialog.

While both async and sync versions are provided, it is recommended to use the async version such that the renderer process is not blocked while the dialog box is open.

The async version accepts the same options as Electron’s dialog.showMessageBox. For convenience, it sets type to 'info' and normalizeAccessKeys to true by default.

If the dialog is closed (via Esc key or X in the top corner) without selecting a button the first button will be clicked unless a “Cancel” or “No” button is provided.

Argument	Description
`options`	An options Object. If the callback argument is also supplied, see the documentation at https://electronjs.org/docs/api/dialog#dialogshowmessageboxbrowserwindow-options-callback for the list of available options. Otherwise, only the following keys are accepted:
`message`	The String message to display.
`detailedMessage`	optional The String detailed message to display.
`buttons`	optional Either an Array of Strings or an Object where keys are button names and the values are callback Functions to invoke when clicked.
`callback`	optional A Function that will be called with the index of the chosen option. If a callback is supplied, the dialog will be non-blocking. This argument is recommended.

AtomEnvironment Essential

Properties

Event Subscription

Extended Methods

Atom Details

Managing The Atom Window

Extended Methods

Messaging the User

Managing the Dev Tools

Extended Methods