Skip to content

getSharedAbortController

The app-wide shared ResettableAbortController.

Every plugin built on this library shares one instance, so a single ResettableAbortController.abort call cancels whatever long-running operation is in flight, whichever plugin started it. A plugin that needs a cancel button of its own scope constructs its own ResettableAbortController instead.

It lives in the shared state, so it is reachable from the devtools console:

__obsidianDevUtils.sharedAbortController.value.abort();

Import:

import { getSharedAbortController } from 'obsidian-dev-utils/abort-controller';

Signature:

function getSharedAbortController(): ResettableAbortController

Returns: ResettableAbortController — The shared ResettableAbortController.