Class DisposableBase`Abstract`

Hierarchy

DisposableBase

Implements

DisposableAware

Index

Constructors

Accessors

Methods

_onDispose dispose throwIfDisposed

Constructors

`Protected` constructor

new DisposableBase(disposableObjectName: string, finalizer?: (() => null | void)): DisposableBase
Parameters
- disposableObjectName: string
- Optional finalizer: (() => null | void)
  - - (): null | void
    - Returns null | void
Returns DisposableBase
- Defined in DisposableBase.ts:20

Accessors

wasDisposed

get wasDisposed(): boolean
Returns boolean
Implementation of DisposableAware.wasDisposed
- Defined in DisposableBase.ts:31

Methods

`Protected` _onDispose

_onDispose(): void
Is called when this object is disposed. Should NOT be called directly. Override this method to handle disposal.

Returns void
- Defined in DisposableBase.ts:78

dispose

dispose(): void
Returns void
Implementation of DisposableAware.dispose
- Defined in DisposableBase.ts:37

`Protected` throwIfDisposed

throwIfDisposed(message?: string, objectName?: string): true
Utility for throwing exception when this object is accessed.
Parameters
- Optional message: string
- objectName: string = ...
  
  Optional object name override.
Returns true
- Defined in DisposableBase.ts:65

Generated using TypeDoc