@vercel/speed-insights

Generate Performance Report

This feature allows you to generate a performance report for a given URL. The `getSpeedInsights` function fetches the performance metrics and returns a detailed report.

const { getSpeedInsights } = require('@vercel/speed-insights');

async function generateReport(url) {
  const report = await getSpeedInsights({ url });
  console.log(report);
}

generateReport('https://example.com');

Custom Configuration

This feature allows you to customize the performance report by specifying options such as the strategy (mobile or desktop) and the categories of metrics to include in the report.

const { getSpeedInsights } = require('@vercel/speed-insights');

async function generateCustomReport(url) {
  const options = {
    strategy: 'mobile',
    categories: ['performance', 'accessibility']
  };
  const report = await getSpeedInsights({ url, options });
  console.log(report);
}

generateCustomReport('https://example.com');

Save Report to File

This feature allows you to save the generated performance report to a file. The `fs` module is used to write the report data to a specified file path.

const { getSpeedInsights } = require('@vercel/speed-insights');
const fs = require('fs');

async function saveReportToFile(url, filePath) {
  const report = await getSpeedInsights({ url });
  fs.writeFileSync(filePath, JSON.stringify(report, null, 2));
  console.log(`Report saved to ${filePath}`);
}

saveReportToFile('https://example.com', './report.json');