Class Timer

Hierarchy

ObservableBase<number>
- Timer

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Timer(_interval: number, _maxCount?: number, _initialDelay?: number): Timer

Overwrites SubscribableBase.constructor
- Defined in source/System/Timers/Timer.ts:17
Parameters
- _interval: number
- Default value _maxCount: number = Infinity
- Default value _initialDelay: number = _interval
Returns Timer

Properties

Private _cancel

_cancel: function

Type declaration

- (): void
- Returns void

Private _count

_count: number = 0

Protected _disposableObjectName

_disposableObjectName: string

Private _initialDelay

_initialDelay: number

Private _interval

_interval: number

Private _maxCount

_maxCount: number

Accessors

count

get count(): number

- Defined in source/System/Timers/Timer.ts:47
Returns number

isRunning

get isRunning(): boolean

- Defined in source/System/Timers/Timer.ts:42
Returns boolean

wasDisposed

get wasDisposed(): boolean

Inherited from DisposableBase.wasDisposed
- Defined in source/System/Disposable/DisposableBase.ts:18
Returns boolean

Methods

Protected _getSubscribers

_getSubscribers(): IObserver<number>[]

Inherited from SubscribableBase._getSubscribers
- Defined in source/System/Observable/SubscribableBase.ts:26
Returns IObserver<number>[]

Protected _onCompleted

_onCompleted(): void

Inherited from ObservableBase._onCompleted
- Defined in source/System/Observable/ObservableBase.ts:37
Returns void

Protected _onDispose

_onDispose(): void

Inherited from SubscribableBase._onDispose

Overwrites DisposableBase._onDispose
- Defined in source/System/Observable/SubscribableBase.ts:94
Returns void

Protected _onError

_onError(error: any): void

Inherited from ObservableBase._onError
- Defined in source/System/Observable/ObservableBase.ts:29
Parameters
- error: any
Returns void

Protected _onNext

_onNext(value: number): void

Inherited from ObservableBase._onNext
- Defined in source/System/Observable/ObservableBase.ts:21
Parameters
- value: number
Returns void

Protected _unsubscribeAll

_unsubscribeAll(returnSubscribers?: boolean): IObserver<number>[]

Inherited from SubscribableBase._unsubscribeAll
- Defined in source/System/Observable/SubscribableBase.ts:76
Parameters
- Default value returnSubscribers: boolean = false
Returns IObserver<number>[]

cancel

cancel(): boolean

Implementation of ICancellable.cancel
- Defined in source/System/Timers/Timer.ts:97
Returns boolean

dispose

dispose(): void

Implementation of ICancellable.dispose

Overwrites DisposableBase.dispose
- Defined in source/System/Timers/Timer.ts:108
Returns void

reset

reset(): void

Implementation of ITimer.reset
- Defined in source/System/Timers/Timer.ts:91
Returns void

start

start(): void

Implementation of ITimer.start
- Defined in source/System/Timers/Timer.ts:52
Returns void

stop

stop(): void

Implementation of ITimer.stop
- Defined in source/System/Timers/Timer.ts:86
Returns void

subscribe

subscribe(subscriber: IObserver<number>): IDisposable

Implementation of IObservable.subscribe

Inherited from SubscribableBase.subscribe
- Defined in source/System/Observable/SubscribableBase.ts:45
Parameters
- subscriber: IObserver<number>
Returns IDisposable

Protected throwIfDisposed

throwIfDisposed(message?: string, objectName?: string): boolean

Inherited from DisposableBase.throwIfDisposed
- Defined in source/System/Disposable/DisposableBase.ts:26
Parameters
- Optional message: string
- Default value objectName: string = this._disposableObjectName
Returns boolean

unsubscribe

unsubscribe(subscriber: IObserver<number>): void

Implementation of IObservable.unsubscribe

Inherited from SubscribableBase.unsubscribe
- Defined in source/System/Observable/SubscribableBase.ts:63
Parameters
- subscriber: IObserver<number>
Returns void

unsubscribeAll

unsubscribeAll(): void

Inherited from SubscribableBase.unsubscribeAll
- Defined in source/System/Observable/SubscribableBase.ts:89
Returns void

Static Private _onTick

_onTick(timer: Timer, reInitTimer?: boolean): void

- Defined in source/System/Timers/Timer.ts:115
Parameters
- timer: Timer
- Optional reInitTimer: boolean
Returns void

Static startNew

startNew(millisecondInterval: number, maxCount?: number, initialDelay?: number): Timer

- Defined in source/System/Timers/Timer.ts:32
Parameters
- millisecondInterval: number
- Default value maxCount: number = Infinity
- Default value initialDelay: number = millisecondInterval
Returns Timer

Generated using TypeDoc