Interface DisposableEvents

Interface for event methods for tracking when an object is disposed.

Hierarchy

DisposableEvents
- UIPart
- Control

Implemented by

Index

Methods

offDispose onDispose

Methods

offDispose

offDispose(token: Token): boolean
Remove event listener from dispose event.

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

onDispose

onDispose(handler: (() => unknown)): Token
Subscribe to onDispose event. This event is triggered whenever the object is disposed.

A component can only be disposed by the end user, by calling the dispose method on the component or the component which owns it.
```
 // Example usage

Dashboard.onDispose(() => {
  console.log('Dashboard was disposed')
})

Dashboard.dispose()
```
Returns
Token of subscription
Parameters
- handler: (() => unknown)
  
  Handler function for event
  - - (): unknown
    - Returns unknown
Returns Token