Class ActivityMonitor<Sender, Args>

A class that monitors activity on a signal.

Type Parameters

Sender
Args

Hierarchy

ActivityMonitor

Implements

IDisposable

Index

Constructors

Properties

_activityStopped _args _isDisposed _onSignalFired _sender _timeout _timer

Accessors

activityStopped isDisposed timeout

Methods

Constructors

constructor

new ActivityMonitor<Sender, Args>(options): ActivityMonitor<Sender, Args>
Construct a new activity monitor.
Type Parameters
- Sender
- Args
Parameters
- options: ActivityMonitor.IOptions<Sender, Args>
Returns ActivityMonitor<Sender, Args>
- Defined in packages/coreutils/lib/activitymonitor.d.ts:10

Properties

`Private` _activityStopped

_activityStopped: any

`Private` _args

_args: any

`Private` _isDisposed

_isDisposed: any

`Private` _onSignalFired

_onSignalFired: any

A signal handler for the monitored signal.

`Private` _sender

_sender: any

`Private` _timeout

_timeout: any

`Private` _timer

_timer: any

Accessors

activityStopped

get activityStopped(): ISignal<this, IArguments<Sender, Args>>
A signal emitted when activity has ceased.

Returns ISignal<this, IArguments<Sender, Args>>
- Defined in packages/coreutils/lib/activitymonitor.d.ts:14

isDisposed

get isDisposed(): boolean
Test whether the monitor has been disposed.

Notes
This is a read-only property.

Returns boolean
Implementation of IDisposable.isDisposed
- Defined in packages/coreutils/lib/activitymonitor.d.ts:26

timeout

get timeout(): number
The timeout associated with the monitor, in milliseconds.

Returns number
- Defined in packages/coreutils/lib/activitymonitor.d.ts:18
set timeout(value): void
Parameters
- value: number
Returns void
- Defined in packages/coreutils/lib/activitymonitor.d.ts:19

Methods

dispose

dispose(): void
Dispose of the resources used by the activity monitor.

Returns void
Implementation of IDisposable.dispose
- Defined in packages/coreutils/lib/activitymonitor.d.ts:30

Generated using TypeDoc