appProcess.current.setOnDispose

API reference for the appProcess.current.setOnDispose method.

Registers a callback that runs when the current app process is about to close.

Apps can't register multiple callbacks.
If an app attempts to register multiple callbacks, only the last callback will be registered.
The app process will remain open until the callback resolves or a timeout error occurs.
The complete execution of the callback is not guaranteed as some user actions (e.g. closing tabs) may close the process prematurely.

Parameters

#callbackOnDisposeCallback<T>

Required

The callback to run when the current app process is about to close.

Parameters

#optsT

Required

Parameters passed to the setOnDispose callback when a process is about to close.

Properties of opts

#reasonCloseReason

Required

The reason the app process is closing.

The available options include:

Returns

Promise<void>

A disposer function that cleans up the registered callback.

() => Promise<void>