Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

timers: enable timers to be used as primitives #19683

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/api/timers.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,15 @@ of the Node.js application.

Returns a reference to the `Timeout`.

### timeout[Symbol.toPrimitive]()

* Returns: {integer}

When coercing a `Timeout` to a primitive, a primitive will be generated that
can be used with the appropriate function that can be used to clear the
`Timeout`. This allows enhanced compatibility with browser `setTimeout`, and
`setInterval` implementations.

## Scheduling Timers

A timer in Node.js is an internal construct that calls a given function after
Expand Down
28 changes: 28 additions & 0 deletions lib/timers.js
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ const kRefed = Symbol('refed');
const refedLists = Object.create(null);
const unrefedLists = Object.create(null);

const KNOWN_TIMERS = Object.create(null);

// Schedule or re-schedule a timer.
// The item must have been enroll()'d first.
Expand Down Expand Up @@ -453,6 +454,13 @@ function rearm(timer, start = TimerWrap.now()) {


const clearTimeout = exports.clearTimeout = function(timer) {
if (typeof timer === 'number' || typeof timer === 'string') {
if (timer in KNOWN_TIMERS) {
timer = KNOWN_TIMERS[timer];
} else {
return;
}
}
if (timer && timer._onTimeout) {
timer._onTimeout = null;
if (timer instanceof Timeout) {
Expand Down Expand Up @@ -497,6 +505,13 @@ exports.setInterval = function(callback, repeat, arg1, arg2, arg3) {
};

exports.clearInterval = function(timer) {
if (typeof timer === 'number' || typeof timer === 'string') {
if (timer in KNOWN_TIMERS) {
timer = KNOWN_TIMERS[timer];
} else {
return;
}
}
if (timer && timer._repeat) {
timer._repeat = null;
clearTimeout(timer);
Expand All @@ -521,6 +536,19 @@ function unrefdHandle(timer, now) {
return true;
}

Timeout.prototype[Symbol.toPrimitive] = function() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why @@toPrimitive rather than valueOf?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see https://codepen.io/bradleymeck/pen/eMMpdR?editors=0012 , .valueOf is not safe for using as a key. toPrimitive handles both string and number coercion.

const id = this[async_id_symbol];
if (id in KNOWN_TIMERS !== true) {
KNOWN_TIMERS[id] = this;
const $close = this.close;
this.close = function() {
delete KNOWN_TIMERS[this[async_id_symbol]];
this.close = $close;
this.close();
};
}
return id;
};

Timeout.prototype.unref = function() {
if (this._handle) {
Expand Down
23 changes: 23 additions & 0 deletions test/parallel/test-timers-toPrimitive.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
'use strict';
const common = require('../common');
const assert = require('assert');

const timeout1 = setTimeout(common.mustNotCall(), 0);
const timeout2 = setInterval(common.mustNotCall(), 0);

assert.strictEqual(Number.isNaN(+timeout1), false);
assert.strictEqual(Number.isNaN(+timeout2), false);

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you check that +timeout1 === timeout1[Symbol.toPrimitive]()?

assert.notStrictEqual(`${timeout1}`, Object.prototype.toString.call(timeout1));
assert.notStrictEqual(`${timeout2}`, Object.prototype.toString.call(timeout2));

assert.notStrictEqual(+timeout1, +timeout2);

const o = {};
o[timeout1] = timeout1;
o[timeout2] = timeout2;
const keys = Object.keys(o);
assert.deepStrictEqual(keys, [`${timeout1}`, `${timeout2}`]);

clearTimeout(keys[0]);
clearInterval(keys[1]);