isomorphic-timers-promises

isomorphic-timers-promises

timers/promises for client and server.

The timers/promises API provides an alternative set of timer functions that return Promise objects.

Install

npm install isomorphic-timers-promises --save

Usage

import {
	setTimeout,
	setImmediate,
	setInterval
} from 'isomorphic-timers-promises';

(async () => {
	const result = await setTimeout(100, 'becky');
	console.log(result); // 'becky'
})();

(async () => {
	const result = await setImmediate('maya');
	console.log(result); // 'maya'
})();

(async () => {
	let result = 0;
	for await (const startTime of setInterval(100, Date.now())) {
		const now = Date.now();
		result = result + 1;
		if (now - startTime >= 1000) {
			break;
		}
	}
	console.log(result); // 10
})();

Usage with Webpack

// webpack.config.js
module.exports = {
	// ...
	resolve: {
		alias: {
			'timers/promises': 'isomorphic-timers-promises'
		}
	}
};

Usage with Rollup

// rollup.config.js
const { default: resolve } = require('@rollup/plugin-node-resolve');
const alias = require('@rollup/plugin-alias');

module.exports = {
	// ...
	plugins: [
		resolve(),
		alias({
			entries: {
				'timers/promises': 'isomorphic-timers-promises'
			}
		})
	]
};

API

setTimeout([delay[, value[, options]]])

Returns: Promise

setImmediate([value[, options]])

Returns: Promise

setInterval([delay[, value[, options]]])

Returns: async iterator that generates values in an interval of delay.

Node and browser support

Supports Node 10+.

Tested in Chrome 72, Firefox 65, Internet Explorer 11 and should work in all modern browsers.

Check support based on Browserslist configuration).

Assumes Promise, AbortController and setImmediate are polyfilled or available in global context.

Test

For automated tests, run npm run test:automated (append :watch for watcher support).

Test suite is taken and modified from official Node.js repository (setTimeout, setImmediate, setInterval).

License

MIT © Ivan Nikolić