timers: support name in validateTimerDuration()

Allow passing a name to validateTimerDuration() so that error
messages can reflect the name of the thing being validated.

PR-URL: https://github.com/nodejs/node/pull/26215
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
cjihrig 2019-02-20 10:47:40 -05:00
parent 4804a18812
commit a1d05e49fe
No known key found for this signature in database
GPG Key ID: 7434390BDBE9B9C5
4 changed files with 6 additions and 6 deletions

View File

@ -737,7 +737,7 @@ ClientRequest.prototype.setTimeout = function setTimeout(msecs, callback) {
}
listenSocketTimeout(this);
msecs = validateTimerDuration(msecs);
msecs = validateTimerDuration(msecs, 'msecs');
if (callback) this.once('timeout', callback);
if (this.socket) {

View File

@ -196,7 +196,7 @@ function setStreamTimeout(msecs, callback) {
this.timeout = msecs;
// Type checking identical to timers.enroll()
msecs = validateTimerDuration(msecs);
msecs = validateTimerDuration(msecs, 'msecs');
// Attempt to clear an existing timer in both cases -
// even if it will be rescheduled we don't want to leak an existing timer.

View File

@ -136,10 +136,10 @@ function setUnrefTimeout(callback, after, arg1, arg2, arg3) {
}
// Type checking used by timers.enroll() and Socket#setTimeout()
function validateTimerDuration(msecs) {
validateNumber(msecs, 'msecs');
function validateTimerDuration(msecs, name) {
validateNumber(msecs, name);
if (msecs < 0 || !isFinite(msecs)) {
throw new ERR_OUT_OF_RANGE('msecs', 'a non-negative finite number', msecs);
throw new ERR_OUT_OF_RANGE(name, 'a non-negative finite number', msecs);
}
// Ensure that msecs fits into signed int32

View File

@ -408,7 +408,7 @@ exports.unenroll = util.deprecate(unenroll,
// This function does not start the timer, see `active()`.
// Using existing objects as timers slightly reduces object overhead.
function enroll(item, msecs) {
msecs = validateTimerDuration(msecs);
msecs = validateTimerDuration(msecs, 'msecs');
// if this item was already in a list somewhere
// then we should unenroll it from that