Module "index"

Const average

• average(scoreStrings: string[], __namedParameters?: { asPercentage: boolean; names: never[]; showDiff: boolean }): Result[]

• Lighthouse average scores calculator.

  example

  Spaced

  average(['14 / 100 / 98 / 100 / (1, 0, 6)']);
  /* Returns:
  [{
    perf: 0.14,
    a11y: 1,
    bp: 0.98,
    seo: 1,
    pwa: { fnr: 0.3333333333333333, ins: 0, po: 0.8571428571428571 },
    average: 0.6157823129251702
  }] * /

  example

  Percentages

  average(['14 / 100 / 98 / 100 / (1, 0, 6)'], { asPercentage: true });
  /* Returns:
  [{
    perf: '14%',
    a11y: '100%',
    bp: '98%',
    seo: '100%',
    pwa: { fnr: '33.33%', ins: '0%', po: '85.71%' },
    average: '61.58%'
  }] * /

  example

  Compressed

  average(['14/100/98/100/(1,0,6)']);
  /* Returns:
  [{
    perf: 0.14,
    a11y: 1,
    bp: 0.98,
    seo: 1,
    pwa: { fnr: 0.3333333333333333, ins: 0, po: 0.8571428571428571 },
    average: 0.6157823129251702
  }] * /

  example

  Difference

  average(['14 / 100 / 98 / 100 / (1, 0, 6)', '28 / 100 / 97 / 100 / (1, 2, 6)'], { showDiff: true });
  /* Returns:
  [{
    perf: 0.14,
    a11y: 1,
    bp: 0.98,
    seo: 1,
    pwa: { fnr: 0.3333333333333333, ins: 0, po: 0.8571428571428571 },
    average: 0.6157823129251702
  },
  {
    perf: 0.14,
    a11y: 0,
    bp: -0.01,
    seo: 1,
    pwa: { fnr: 0, ins: 0.66666666666666, po: 0.8571428571428571 },
    average: 0.1138095238095237
  }] * /

  For more ways to input scores, please see the unit tests in __tests__/

  Parameters

  • scoreStrings: string[]

    List of Lighthouse score strings of the form ('num / num / num / num / (num, num, num)')

  • Default value __namedParameters: { asPercentage: boolean; names: never[]; showDiff: boolean } = {}

    • asPercentage: boolean

    • names: never[]

    • showDiff: boolean

  Returns Result[]

  Results with the individual scores for each metrics.