registerDisposable<TDisposable>
Registers a Disposable so it is disposed when the component unloads, and returns it unchanged.
The recurring “tie a disposable to the component’s lifecycle, then keep using it” idiom, for any component: registerDisposable(plugin, await registerVirtualFile(...)). The disposable is disposed on Component.unload, or earlier if the caller disposes it directly, since disposal is expected to be idempotent. A component that is never loaded never unloads, so its registered disposables are never disposed.
Import:
import { registerDisposable } from '@mnaoumov/obsidian-lib/disposable';Signature:
function registerDisposable(component: Component, disposable: TDisposable): TDisposableParameters:
| Parameter | Type | Description |
|---|---|---|
component |
Component | The component whose unload disposes the disposable. |
disposable |
TDisposable | The disposable to register. |
Returns: TDisposable — The same disposable, for chaining.