Explain clearTimeout() function in Node.js

The clearTimeout() function in Node.js is used to cancel a timeout that was previously established by calling setTimeout(). When you set a timeout using setTimeout(), it returns a timeout ID which you can later use to cancel the timeout if necessary. This can be particularly useful for stopping a scheduled function from executing after a specified delay, often in scenarios where the execution of the function becomes unnecessary or conditions change.

Syntax:

clearTimeout(timeoutID);

Parameter:

• timeoutID: The identifier of the timeout you want to cancel, which is returned by the setTimeout() function.

Key Points of clearTimeout()

• Purpose: Cancel a scheduled function call.
• Usage: Prevents the function passed to setTimeout() from being executed.
• Parameter: Takes a timeout ID (returned by setTimeout()) as its parameter.
• Behaviour: No effect if the timeout has already been executed or if the ID does not correspond to a valid timeout.

Cancelling a Scheduled Function Call

Suppose you set a timeout to log a message after 5 seconds. You can cancel it before it executes.

const timeoutID = setTimeout(() => {
    console.log('This will not be printed');
}, 5000);

// Cancel the timeout
clearTimeout(timeoutID);

In this example, the clearTimeout(timeoutID) function call ensures that the console.log statement inside setTimeout() is never executed.

Conditionally Cancelling a Timeout

You can set a timeout to perform an action, such as fetching data, but cancel it if certain conditions are met.

let shouldCancel = true;

const timeoutID = setTimeout(() => {
    console.log('Fetching data...');
}, 3000);

if (shouldCancel) {
    clearTimeout(timeoutID);
    console.log('Timeout cancelled');
}

Here, if shouldCancel is true, the timeout is cancelled, and the message “Fetching data…” is never logged.

Example: The setTimeout inside the script tag is registering a function to be executed after 3000 milliseconds and inside the function, there is only an alert.

function alertAfter3Seconds() {
    console.log("Hi, 3 Second completed!");
}
setTimeout(alertAfter3Seconds, 3000);

Output:

Hi, 3 Second completed!

JavaScript clearTimeout() Method:

This method comes under the category of canceling timers and is used to cancel the timeout object created by setTimeout. The setTimeout() method also returns a unique timer id which is passed to clearTimeout to prevent the execution of the functionality registered by setTimeout. 

Example: Here we have stored the timer id returned by setTimeout, and later we are passing it to the clearTimeout method which immediately aborts the timer.

function alertAfter3Seconds() {
    alert("Hi, 3 Second completed!");
}

const timerId = setTimeout(alertAfter3Seconds, 3000);

clearTimeout(timerId);
console.log("Timer has been Canceled");

Output: Here we will not be able to see that alert registered to be executed after 3000 milliseconds because clearTimeout canceled that timer object before execution.

Timer has been Canceled

Best Practices

• Use clear naming conventions: When dealing with multiple timeouts, use descriptive variable names for timeout IDs to avoid confusion.
• Check if the timeout exists: Before calling clearTimeout(), ensure that the timeout ID is valid to avoid unnecessary function calls.
• Clean up in asynchronous operations: Always clear timeouts in asynchronous operations or event listeners to prevent potential memory leaks or unwanted behavior.

Conclusion

The clearTimeout() function in Node.js is a powerful tool for managing the execution of delayed functions. It provides control over timeouts, allowing you to cancel them based on dynamic conditions or events. Understanding how to use clearTimeout() effectively helps in creating responsive and efficient applications.

mrtwinklesharma

Follow

Improve

Article Tags :

• Blogathon
• Node.js
• Web Technologies
• Blogathon-2021
• Node.js-Methods
• NodeJS-Questions

+2 More