integrations/webVitals/webVitalsRouteSummary

Variables

scoring

const scoring: {
  good: number;
  needs-improvement: number;
  poor: number;
};

Defined in: studiocms/packages/studiocms/src/integrations/webVitals/webVitalsRouteSummary.ts:104^

Type Declaration

good

good: number = 1;

needs-improvement

needs-improvement: number = 0.5;

poor

poor: number = 0;

---

weighting

const weighting: {
  CLS: number;
  INP: number;
  LCP: number;
};

Defined in: studiocms/packages/studiocms/src/integrations/webVitals/webVitalsRouteSummary.ts:103^

Scoring Function: Computes a weighted score for core web vitals

Type Declaration

CLS

CLS: number = 0.3;

INP

INP: number = 0.3;

LCP

LCP: number = 0.4;

Functions

processWebVitalsRouteSummary()

function processWebVitalsRouteSummary(data: WebVitalsResponseItem[]): WebVitalsRouteSummary[];

Defined in: studiocms/packages/studiocms/src/integrations/webVitals/webVitalsRouteSummary.ts:25^

Processes an array of Web Vitals response items and returns a summary of web vitals for each route.

Parameters

data

WebVitalsResponseItem[]

An array of WebVitalsResponseItem objects representing the web vitals data.

Returns

WebVitalsRouteSummary[]

An array of WebVitalsRouteSummary objects summarizing the web vitals for each route.

The function performs the following steps:

1. Groups the data by route and name.
2. Processes each group separately, ensuring the sample size is at least 4.
3. Sorts the metrics within each group by rating and value.
4. Assigns quartiles to the metrics using NTILE(4) logic.
5. Identifies the end of each quartile.
6. Selects only the metrics in quartile 3 where quartile_end is true.
7. Converts the selected metrics into WebVitalsRouteSummary structures.

The resulting summaries include the route, whether the route passes core web vitals, the metrics for LCP, CLS, and INP, and a score.

---

simpleScore()

function simpleScore(
   lcpRating: "good" | "needs-improvement" | "poor",
   clsRating: "good" | "needs-improvement" | "poor",
   inpRating: "good" | "needs-improvement" | "poor"): number;

Defined in: studiocms/packages/studiocms/src/integrations/webVitals/webVitalsRouteSummary.ts:106^

Parameters

lcpRating

"good" | "needs-improvement" | "poor"

clsRating

"good" | "needs-improvement" | "poor"

inpRating

"good" | "needs-improvement" | "poor"

Returns

number