@guardian/core-web-vitals

中文文档
22.0.0发布于 2026/06/10TypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 1.9万

Methods to help with the implementation of Google's Core Web Vitals

原始使用文档
文档目录10 节
  1. Installation
  2. Bundling
  3. Usage
  4. init.sampling
  5. init.team
  6. init.platform
  7. bypassCoreWebVitalsSampling
  8. Types
  9. CoreWebVitalsPayload
  10. InitCoreWebVitalsOptions

@guardian/core-web-vitals

npm (scoped) ES version npm type definitions

Installation

Generic badge

yarn add @guardian/core-web-vitals

or

npm install @guardian/core-web-vitals

then

import {
    initCoreWebVitals,
    bypassCoreWebVitalsSampling,
} from '@guardian/core-web-vitals';

Bundling

This package uses ES2020.

If your target environment does not support that, make sure you transpile this package when bundling your application.

Usage

By default, a sampling rate is set at 1% for which Core Web Vitals will be gathered and sent. It is possible to set this sampling to a different value at initialisation or bypass it asynchronously (see below).

import { initCoreWebVitals, getCookie } from '@guardian/core-web-vitals';

// browserId & pageViewId are needed to join up the data downstream.
const init: InitCoreWebVitalsOptions = {
    browserId: getCookie({ name: 'bwid', shouldMemoize: true }),
    pageViewId: guardian.config.ophan.pageViewId,

    // Whether to use CODE or PROD endpoints.
    isDev: window.location.hostname !== 'www.theguardian.com',
};

initCoreWebVitals(init);

init.sampling

Sets a sampling rate for which to send data to the logging endpoint.

Defaults to 1 / 100.

const init: InitCoreWebVitalsOptions = {
    isDev: false,

    // Send data for 20% of page views. Inform Data Tech team about expected
    // spikes in data ingestion
    sampling: 20 / 100,
};

initCoreWebVitals(init);

init.team

Optional team name to log whether the payload has been successfully queued for transfer.

const init: InitCoreWebVitalsOptions = {
    isDev: false,
    sampling: 100 / 100,
    team: 'dotcom',
};

initCoreWebVitals(init);

// should call log('dotcom', 'Core Web Vitals payload successfully queued […]')

init.platform

Optional platform which is passed through to the events-collector and can be used to segment data downstream. Defaults to dcr in the events-collector if not specified.

const init: InitCoreWebVitalsOptions = {
    isDev: false,
    platform: 'support',
};

initCoreWebVitals(init);

bypassCoreWebVitalsSampling

Allows to asynchronously bypass the sampling rate.

Takes an optional team name for which to print logs for.

/* … after having called initCoreWebVitals() … */

addEventListener('some-event', () => {
    // CWV will be sent for all page views where `some-event` was triggered
    bypassCoreWebVitalsSampling();
});

Types

CoreWebVitalsPayload

type CoreWebVitalsPayload = {
    page_view_id: string | null;
    browser_id: string | null;
    fid: null | number;
    cls: null | number;
    lcp: null | number;
    fcp: null | number;
    ttfb: null | number;
};

InitCoreWebVitalsOptions

type InitCoreWebVitalsOptions = {
    isDev: boolean;

    browserId?: string | null;
    pageViewId?: string | null;

    sampling?: number;
    team?: TeamName;
};

版本与发布记录

@guardian/core-web-vitals 共发布 199 个版本,首次发布于 2022/11/14;过去 12 个月发布了 34 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
22.0.0latest2026/06/105 个月前
0.0.0-canary-20260518131757canary2026/05/185 个月前
21.0.02026/05/146 个月前
0.0.0-canary-202604301412582026/04/306 个月前
0.0.0-canary-202604301408592026/04/306 个月前
0.0.0-canary-202604300923262026/04/306 个月前

关于 @guardian/core-web-vitals 的常见问题

@guardian/core-web-vitals 是什么?

Methods to help with the implementation of Google's Core Web Vitals

如何安装 @guardian/core-web-vitals?

在项目目录运行 npm install @guardian/core-web-vitals,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@guardian/libs(^33.0.0)、tslib(^2.8.1)、web-vitals(^5.2.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@guardian/core-web-vitals 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@guardian/core-web-vitals 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@guardian/core-web-vitals 可以商用吗?

@guardian/core-web-vitals 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@guardian/core-web-vitals 的下载量有多少?

根据 npm 官方下载统计,@guardian/core-web-vitals 在 2026/10/17 – 2026/11/15 这 30 天内被下载 19,423 次,日均约 647 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@guardian/core-web-vitals 还在维护吗?

最新版本 22.0.0 发布于 2026/06/10(5 个月前);至今共发布 199 个版本,其中过去 12 个月发布了 34 个;首次发布于 2022/11/14。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。