appProcess.current.setOnDispose

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.

import { appProcess } from '@canva/platform';

const cleanupDisposer = appProcess.current.setOnDispose(async (params) => {
  if (params.reason === 'completed') {
    await saveChanges();
  }
});

// Later: cleanup the listener
await cleanupDisposer();

A disposer function that cleans up the registered callback.

() => Promise<void>