🎩 A helper for working with individual Progressive Web App metrics (via Lighthouse)
APACHE-2.0 License
The pwmetrics module exposes the ability to get use performance metrics out of Lighthouse. This includes the ability to perform multiple runs. This module provides a simple API on top of pwmetrics for plucking out values of specific metrics.
$ npm install --save pwmetrics-helper
The desiredMetric
field takes one of the following metrics and will return just
that value from the median runs:
const getMetrics = require('pwmetrics-helper');
getMetrics('https://airhorner.com', {
desiredMetric: 'Time to Interactive'
}).then(score => {
// do something with the score
});
const getMetrics = require('pwmetrics-helper');
getMetrics('https://airhorner.com', {
runs: 2,
desiredMetric: 'First Contentful Paint'
}).then(score => {
// do something with the FCP
});
const getMetrics = require('pwmetrics-helper');
getMetrics('https://airhorner.com').then(data => {
// do something with the data
});
runs
specifies the number of runs of Lighthouse to perform via pwmetrics
before a median score is returned. This module generally defaults to 3 runs.
Apache 2.0. Google Inc.