We need this JSDoc comment for affecting ESDoc.
class VirtualAction<T> extends AsyncAction {
static sortActions<T>(a: VirtualAction<T>, b: VirtualAction<T>)
constructor(scheduler: VirtualTimeScheduler, work: (this: SchedulerAction<T>, state?: T) => void, index: number = scheduler.index += 1)
protected active: boolean
protected scheduler: VirtualTimeScheduler
protected work: (this: SchedulerAction<T>, state?: T) => void
protected index: number
schedule(state?: T, delay: number = 0): Subscription
protected requestAsyncId(scheduler: VirtualTimeScheduler, id?: any, delay: number = 0): any
protected recycleAsyncId(scheduler: VirtualTimeScheduler, id?: any, delay: number = 0): any
protected _execute(state: T, delay: number): any
}
Static Methods
sortActions()
|
|---|
static sortActions<T>(a: VirtualAction<T>, b: VirtualAction<T>)
Parameters
| a |
Type: VirtualAction.
|
| b |
Type: VirtualAction.
|
|
Constructor
constructor(scheduler: VirtualTimeScheduler, work: (this: SchedulerAction<T>, state?: T) => void, index: number = scheduler.index += 1)
Parameters
| scheduler |
Type: VirtualTimeScheduler.
|
| work |
Type: (this: SchedulerAction, state?: T) => void.
|
| index |
Optional. Default is scheduler.index += 1.
Type: number.
|
|
Properties
| Property | Type | Description |
|---|
| active |
|
|
| scheduler |
|
Declared in constructor.
|
| work |
|
Declared in constructor.
|
| index |
|
Declared in constructor.
|
Methods
schedule()
|
|---|
schedule(state?: T, delay: number = 0): Subscription
Parameters
| state |
Optional. Default is undefined.
Type: T.
|
| delay |
Optional. Default is 0.
Type: number.
|
Returns
Subscription
|
requestAsyncId()
|
|---|
protected requestAsyncId(scheduler: VirtualTimeScheduler, id?: any, delay: number = 0): any
Parameters
| scheduler |
Type: VirtualTimeScheduler.
|
| id |
Optional. Default is undefined.
Type: any.
|
| delay |
Optional. Default is 0.
Type: number.
|
Returns
any
|
recycleAsyncId()
|
|---|
protected recycleAsyncId(scheduler: VirtualTimeScheduler, id?: any, delay: number = 0): any
Parameters
| scheduler |
Type: VirtualTimeScheduler.
|
| id |
Optional. Default is undefined.
Type: any.
|
| delay |
Optional. Default is 0.
Type: number.
|
Returns
any
|
_execute()
|
|---|
protected _execute(state: T, delay: number): any
Parameters
| state |
Type: T.
|
| delay |
Type: number.
|
Returns
any
|