Skip to content

asDisposableComponent<TComponent>

Convert component to a DisposableEx interface by adding Symbol.dispose and a convenience DisposableEx.dispose method that unloads the component when disposed.

An existing Symbol.dispose is preserved; the convenience DisposableEx.dispose method always delegates to it. The passed component is mutated in place and returned, so the call is idempotent.

Import:

import { asDisposableComponent } from 'obsidian-dev-utils/obsidian/components/disposable-component';

Signature:

function asDisposableComponent(component: TComponent): DisposableComponentWrapper<TComponent>

Parameters:

ParameterTypeDescription
componentTComponentThe component instance to wrap with Disposable support.

Returns: DisposableComponentWrapper<TComponent> — The component cast to DisposableComponentWrapper with Symbol.dispose and dispose attached.