VirtualTimeScheduler
class
stable
class VirtualTimeScheduler extends AsyncScheduler { static frameTimeFactor: 10 constructor(schedulerActionCtor: typeof AsyncAction = VirtualAction as any, maxFrames: number = Infinity) frame: number index: number maxFrames: number flush(): void }
Subclasses
Static Properties
Property | Type | Description |
---|---|---|
frameTimeFactor |
10 |
Constructor
This creates an instance of a VirtualTimeScheduler
. Experts only. The signature of this constructor is likely to change in the long run.
constructor(schedulerActionCtor: typeof AsyncAction = VirtualAction as any, maxFrames: number = Infinity)
Parameters
schedulerActionCtor |
typeof AsyncAction |
Optional. Default is The type of Action to initialize when initializing actions during scheduling. |
maxFrames |
number |
Optional. Default is The maximum number of frames to process before stopping. Used to prevent endless flush cycles. |
Properties
Property | Type | Description |
---|---|---|
frame |
number |
The current frame for the state of the virtual scheduler instance. The the difference between two "frames" is synonymous with the passage of "virtual time units". So if you record |
index |
number |
Used internally to examine the current virtual action index being processed. |
maxFrames |
number |
The maximum number of frames to process before stopping. Used to prevent endless flush cycles. Declared in constructor. |
Methods
flush(): void
Prompt the Scheduler to execute all of its queued actions, therefore clearing its queue.
Parameters
There are no parameters.
Returns
void
:
© 2015–2022 Google, Inc., Netflix, Inc., Microsoft Corp. and contributors.
Code licensed under an Apache-2.0 License. Documentation licensed under CC BY 4.0.
https://rxjs.dev/api/index/class/VirtualTimeScheduler