AsyncEventRefDisposable

An AsyncDisposableEx that unregisters an AsyncEventRef on dispose, via the event source stored on the ref itself. Async counterpart of the native EventRefDisposable.

Import:

import { AsyncEventRefDisposable } from 'obsidian-dev-utils/async-events';

Signature:

export class AsyncEventRefDisposable extends AsyncDisposableBase

Extends: AsyncDisposableBase

Constructor

new AsyncEventRefDisposable(asyncEventRef: AsyncEventRef)

Creates a disposable wrapping an existing AsyncEventRef.

Properties

Property	Type	Description
multipleDisposeBehavior	MultipleDisposeBehavior	How the disposable behaves when disposed more than once. (Inherited from AsyncDisposableBase)

Methods

Method	Returns	Description
[Symbol.asyncDispose]()	Promise<void>	Disposes the object by running AsyncDisposableBase.performDisposeAsync, honoring the configured MultipleDisposeBehavior on a repeat dispose. (Inherited from AsyncDisposableBase)
asyncDispose()	Promise<void>	Disposes the object. Convenience alias that delegates to this[Symbol.asyncDispose](). (Inherited from AsyncDisposableBase)
performDisposeAsync()	void	Unregisters the event via the source stored on the ref (asyncEventSource.offref).