App Module

The app module of the Bubbledesk bridge provides methods to retrieve system-level information and control the main application. Use this module when you need to access details about the app environment or programmatically exit the application.

Overview

The app interface is responsible for:

• Fetching general information about the running Bubbledesk application and its environment.
• Allowing programmatic exit of the app (with appropriate permissions).

These features are useful for diagnostics, analytics, and scenarios where the app needs to be closed from code (e.g., after a critical error or on user request).

Methods

Method	Description	Return Type
info()	Retrieves detailed information about the Bubbledesk app instance, including version, platform, and environment.	Promise<AppInfo>
exit()	Closes the Bubbledesk application. Requires sufficient permissions and may not be available in all contexts.	Promise<void>

AppInfo structure

The AppInfo object returned by info() contains the following fields:

Field	Type	Description
arch	string	The system architecture (e.g., x64, arm64).
current_dir	string	The current working directory of the app process.
exec_dir	string	The directory where the app executable is located.
exec_path	string	The full path to the app executable file.
has_main_window	boolean	Indicates whether the app currently has a main window open.
is_debug	boolean	Indicates if the app is running in debug mode.
name	string	The display name of the application.
now_unix_ms	number	The current timestamp in milliseconds since Unix epoch.
os	string	The operating system platform (e.g., win32, darwin).
pid	number	The process ID of the running app instance.
primary_screen	AppScreenInfo	Information about the primary display screen.
screens	AppScreenInfo[]	Array of information objects for all connected display screens.
temp_dir	string	The path to the temporary directory used by the app.
version	string	The version of the Bubbledesk app.
windows	AppWindowInfo[]	Array of information objects for all open app windows.

Related Types

AppWindowInfo

Field	Type	Description
label	string	The window's label or identifier.
width	number	The window's width in pixels.
height	number	The window's height in pixels.
x	number	The x-coordinate of the window.
y	number	The y-coordinate of the window.
is_fullscreen	boolean	Whether the window is fullscreen.
is_maximized	boolean	Whether the window is maximized.
is_minimized	boolean	Whether the window is minimized.
is_visible	boolean	Whether the window is visible.

AppScreenInfo

Field	Type	Description
name	string	The screen's name or identifier.
width	number	The screen's width in pixels.
height	number	The screen's height in pixels.
x	number	The x-coordinate of the screen.
y	number	The y-coordinate of the screen.
scale_factor	number	The screen's scale factor.

Example Usage

// Retrieve app information
const info = await Bubbledesk.app.info();
console.log('Platform:', info.os);

Notes

Efficient usage of info()

Cache the result of info() if you need app details multiple times, as the information is static for the session and repeated calls may be unnecessary.

WARNING

The exit() method will immediately terminate the Bubbledesk app if permissions allow. Use this method with caution and always ensure the user is notified or has saved their work.