Global

Methods

sessionBus(optionsopt)

Create a new MessageBus client on the DBus session bus to connect to interfaces or request service names.

Parameters:
Name Type Attributes Description
options object <optional>

Options for MessageBus creation.

Properties
Name Type Attributes Description
busAddress object <optional>

The socket path for the session bus. Defaults to finding the bus address in the manner specified in the DBus specification. The bus address will first be read from the DBUS_SESSION_BUS_ADDRESS environment variable and when that is not available, found from the $HOME/.dbus directory.
Source:

setBigIntCompat(compat)

Use JSBI as a polyfill for long integer types ('x' and 't') in the client and the service. This is required for Node verisons that do not support the native BigInt class which is used by default for these types (version < 10.8.0).

Parameters:
Name Type Description
compat boolean

pass true to use JSBI.
Source:

systemBus()

Create a new MessageBus client on the DBus system bus to connect to interfaces or request service names. Connects to the socket specified by the DBUS_SYSTEM_BUS_ADDRESS environment variable or unix:path=/var/run/dbus/system_bus_socket.

Source:

Type Definitions

methodHandler(msg) → {boolean}

A function to call when a message of type MessageType.METHOD_RETURN is received. User handlers are run before default handlers.

Parameters:
Name Type Description
msg Message

The message to handle.
Source:
Returns:

Return true if the message is handled and no further handlers will run.

Type
boolean