A handle to a resource that can be disposed. You can use it by requiring event-kit module.

import { Disposable } from 'event-kit'



Ensure that object correctly implements the Disposable contract.

Return values

Returns a Boolean indicating whether object is a valid Disposable.

Construction and Destruction


Construct a Disposable

Argument Description
disposalAction() A Function to call when ::dispose is called for the first time.


Perform the disposal action, indicating that the resource associated with this disposable is no longer needed.

You can call this method more than once, but the disposal action will only be performed the first time.

Can you help us improve these docs?

The source of these docs is here on GitHub. If you see a way these docs can be improved, please fork us!