Skip to content

Richienb/refresh-rate

Repository files navigation

refresh-rate Travis CI Build Status

Get the monitor refresh rate.

NPM Badge

Install

npm install refresh-rate

Usage

const refreshRate = require("refresh-rate");

(async () => {
	console.log(await refreshRate());
	//=> 60

	console.log(await refreshRate({ sampleCount: 120 }));
	//=> 60
})();

API

refreshRate(options?)

options

Type: object

sampleCount

Type: number
Default: 50

The amount of frame samples to take before computing the refresh rate.

To compute within ±2 frames of error, 50 samples are sufficient. However, if you can afford to wait a few more seconds, 120-200 samples can be taken for a more accurate reading.