Class DockviewEmitter<T>

Events, Emitters and Disposables are very common concepts that many codebases will contain, however we need to export them for dockview framework packages to use. To be a good citizen these are exported with a Dockview prefix to prevent accidental use by others.

Type Parameters

T

Implements

DockviewIDisposable

Index

Constructors

Properties

ENABLE_TRACKING MEMORY_LEAK_WATCHER

Accessors

Methods

dispose fire pause setLeakageMonitorEnabled

Constructors

constructor

new DockviewEmitter<T>(options?: EmitterOptions): DockviewEmitter<T>
Type Parameters
- T
Parameters
- Optionaloptions: EmitterOptions
Returns DockviewEmitter<T>
- Defined in events.ts:124

Properties

`Static`ENABLE_TRACKING

ENABLE_TRACKING: boolean = false

`Static` `Readonly`MEMORY_LEAK_WATCHER

MEMORY_LEAK_WATCHER: LeakageMonitor = ...

Accessors

event

get event(): DockviewEvent<T>
Returns DockviewEvent<T>
- Defined in events.ts:126

value

get value(): T | undefined
Returns T | undefined
- Defined in events.ts:120

Methods

dispose

dispose(): void
Returns void
Implementation of DockviewIDisposable.dispose
- Defined in events.ts:184

fire

fire(e: T): void
Parameters
- e: T
Returns void
- Defined in events.ts:164

pause

pause(): DockviewIDisposable
Returns DockviewIDisposable
- Defined in events.ts:178

`Static`setLeakageMonitorEnabled

setLeakageMonitorEnabled(isEnabled: boolean): void
Parameters
- isEnabled: boolean
Returns void
- Defined in events.ts:113