@angular/core/testing

tick

function

Simulates the asynchronous passage of time for the timers in the fakeAsync zone.

  
    function tick(  millis?: number,  tickOptions?: { processNewMacroTasksSynchronously: boolean; }): void;

Simulates the asynchronous passage of time for the timers in the fakeAsync zone.

The microtasks queue is drained at the very start of this function and after any timer callback has been executed.

The tick() option is a flag called processNewMacroTasksSynchronously, which determines whether or not to invoke new macroTasks.

If you provide a tickOptions object, but do not specify a processNewMacroTasksSynchronously property (tick(100, {})), then processNewMacroTasksSynchronously defaults to true.

If you omit the tickOptions parameter (tick(100))), then tickOptions defaults to {processNewMacroTasksSynchronously: true}.

Example

The following example includes a nested timeout (new macroTask), and the tickOptions parameter is allowed to default. In this case, processNewMacroTasksSynchronously defaults to true, and the nested function is executed on each tick.

          it ('test with nested setTimeout', fakeAsync(() => {  let nestedTimeoutInvoked = false;  function funcWithNestedTimeout() {    setTimeout(() => {      nestedTimeoutInvoked = true;    });  };  setTimeout(funcWithNestedTimeout);  tick();  expect(nestedTimeoutInvoked).toBe(true);}));

In the following case, processNewMacroTasksSynchronously is explicitly set to false, so the nested timeout function is not invoked.

          it ('test with nested setTimeout', fakeAsync(() => {  let nestedTimeoutInvoked = false;  function funcWithNestedTimeout() {    setTimeout(() => {      nestedTimeoutInvoked = true;    });  };  setTimeout(funcWithNestedTimeout);  tick(0, {processNewMacroTasksSynchronously: false});  expect(nestedTimeoutInvoked).toBe(false);}));

tick

void

Simulates the asynchronous passage of time for the timers in the fakeAsync zone.

The microtasks queue is drained at the very start of this function and after any timer callback has been executed.

@parammillisnumber

The number of milliseconds to advance the virtual timer.

@paramtickOptions{ processNewMacroTasksSynchronously: boolean; }

The options to pass to the tick() function.

@returnsvoid

Usage notes

The tick() option is a flag called processNewMacroTasksSynchronously, which determines whether or not to invoke new macroTasks.

If you provide a tickOptions object, but do not specify a processNewMacroTasksSynchronously property (tick(100, {})), then processNewMacroTasksSynchronously defaults to true.

If you omit the tickOptions parameter (tick(100))), then tickOptions defaults to {processNewMacroTasksSynchronously: true}.

Example

The following example includes a nested timeout (new macroTask), and the tickOptions parameter is allowed to default. In this case, processNewMacroTasksSynchronously defaults to true, and the nested function is executed on each tick.

          it ('test with nested setTimeout', fakeAsync(() => {  let nestedTimeoutInvoked = false;  function funcWithNestedTimeout() {    setTimeout(() => {      nestedTimeoutInvoked = true;    });  };  setTimeout(funcWithNestedTimeout);  tick();  expect(nestedTimeoutInvoked).toBe(true);}));

In the following case, processNewMacroTasksSynchronously is explicitly set to false, so the nested timeout function is not invoked.

          it ('test with nested setTimeout', fakeAsync(() => {  let nestedTimeoutInvoked = false;  function funcWithNestedTimeout() {    setTimeout(() => {      nestedTimeoutInvoked = true;    });  };  setTimeout(funcWithNestedTimeout);  tick(0, {processNewMacroTasksSynchronously: false});  expect(nestedTimeoutInvoked).toBe(false);}));