Documentation / base / Disposable

Class: Disposable

Defined in: libs/base/src/ref.ts:17

Base class for any Disposable class

Extends

• Observable<{ dispose: []; }>

Implements

• IDisposable

Constructors

Constructor

new Disposable(): Disposable

Defined in: libs/base/src/ref.ts:19

Returns

Disposable

Overrides

Observable.constructor

Accessors

disposed

Get Signature

get disposed(): boolean

Defined in: libs/base/src/ref.ts:23

Returns

boolean

Implementation of

IDisposable.disposed

Methods

on()

on<K>(type, listener, context?): void

Defined in: libs/base/src/event.ts:104

Sets up a function that will be called whenever the specified event is delivered to the target

Type Parameters

K

K extends "dispose"

Parameters

type

K

The event type to listen for

listener

EventListener<{ dispose: []; }, K>

The callback function

context?

unknown

Context object of the listener function

Returns

void

Implementation of

IDisposable.on

Inherited from

Observable.on

---

once()

once<K>(type, listener, context?): void

Defined in: libs/base/src/event.ts:117

Sets up a function that will be called only once when the specified event is delivered to the target

Type Parameters

K

K extends "dispose"

Parameters

type

K

The event type to listen for

listener

EventListener<{ dispose: []; }, K>

The callback function

context?

unknown

Context object of the listener function

Returns

void

Implementation of

IDisposable.once

Inherited from

Observable.once

---

off()

off<K>(type, listener?, context?): void

Defined in: libs/base/src/event.ts:130

Removes an event listener function previously registered.

Type Parameters

K

K extends "dispose"

Parameters

type

K

The event type for which to remove an event listener

listener?

EventListener<{ dispose: []; }>

The callback function to be removed

context?

unknown

Returns

void

Implementation of

IDisposable.off

Inherited from

Observable.off

---

dispatchEvent()

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/src/event.ts:138

Synchronously invoke the affected event listeners with an event object

Type Parameters

K

K extends "dispose"

Parameters

type

K

args

...object[K]

Returns

void

false if the event was canceled, otherwise true

Implementation of

IDisposable.dispatchEvent

Inherited from

Observable.dispatchEvent

---

dispose()

dispose(): void

Defined in: libs/base/src/ref.ts:26

Returns

void

Implementation of

IDisposable.dispose

---

onDispose()

protected onDispose(): void

Defined in: libs/base/src/ref.ts:33

Returns

void