yellowlabtools_nodejs_api_performance_audit_quickstart.ts

1import yellowLabTools from 'yellowlabtools';
2
3/**
4 * Quickstart: Run a YellowLabTools audit on a specific URL.
5 * Note: yellowlabtools does not currently provide official @types, 
6 * so you may need to use `any` or define a custom interface for the results.
7 */
8async function runAudit(url: string): Promise<void> {
9  try {
10    console.log(`Starting audit for: ${url}...`);
11
12    // Run the audit with default options
13    const results: any = await yellowLabTools.launch(url);
14
15    // The results object contains scores, metrics, and global performance data
16    const globalScore: number = results.score;
17    
18    console.log('Audit complete!');
19    console.log(`Global Performance Score: ${globalScore}/100`);
20    
21    // Example: Accessing a specific metric
22    if (results.profiles && results.profiles.desktop) {
23        console.log(`Page Weight: ${results.profiles.desktop.globalMetrics.base_page_size} bytes`);
24    }
25
26  } catch (error) {
27    console.error('An error occurred during the audit:', error);
28  }
29}
30
31// Execute the quickstart
32runAudit('https://www.google.com');