# @guardian/core-web-vitals 中文文档

规范地址：https://npmcn.com/package/%40guardian/core-web-vitals/

版本：22\.0\.0
npm 元数据更新时间：2026-06-10T10:20:47.246Z
中文译文更新时间：2026-11-17T02:48:02.884Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40guardian/core-web-vitals
原文对照：https://npmcn.com/package/%40guardian/core-web-vitals/?lang=original
项目主页：https://github.com/guardian/csnx#readme
源码仓库：https://github.com/guardian/csnx

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：28.6 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@guardian/libs ^33\.0\.0，tslib ^2\.8\.1，typescript ~6\.0\.3，web-vitals ^5\.2\.0
- 首次发布：2022-11-14T12:03:50.301Z
- 最新版本发布：2026-06-10T10:20:46.839Z
- 近 30 天下载量：19423（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：199（近 12 个月 34 个）

## 中文简介

帮助实施Google核心网络维度的方法

## 安装

```sh
npm install @guardian/core-web-vitals
```

也可以使用：`pnpm add @guardian/core-web-vitals`、`yarn add @guardian/core-web-vitals`、`bun add @guardian/core-web-vitals`

## README

# `@guardian/core-web-vitals`

[![npm (scoped)](https://img.shields.io/npm/v/@guardian/core-web-vitals)](https://www.npmjs.com/package/@guardian/core-web-vitals) [![ES version](https://badgen.net/badge/ES/2020/cyan)](https://tc39.es/ecma262/2020/) [![npm type definitions](https://img.shields.io/npm/types/@guardian/core-web-vitals)](https://www.typescriptlang.org/)

## 安装

[![Generic badge](https://img.shields.io/badge/google-chat-259082.svg)](https://chat.google.com/room/AAAAWwBdSMs)

```bash
yarn add @guardian/core-web-vitals
```

或者说

```bash
npm install @guardian/core-web-vitals
```

接下来

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

### 捆绑

此软件包使用 `ES2020`。 。 。 .

如果目标环境不支持此选项, 请在捆绑您的应用程序时确保您转换此软件包 .

## 使用量

_默认情况下,采样率将定为1%,核心网络维度将为1% 集众出使. 可将样本设定为不同值 启动或同步绕过(见下文)._

```js
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`

设置一个采样率,将数据发送到伐木端点.

默认为 `1 / 100`。 。 。 .

```ts
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`

登录有效载荷是否成功排队的可选团队名称 转移.

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

initCoreWebVitals(init);

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

### `init.platform`

可选的平台,可以传递给事件收集器 用于分解下游数据. 默认为 `dcr` 在事件收集中,如果 未指定.

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

initCoreWebVitals(init);
```

### `bypassCoreWebVitalsSampling`

允许同步绕过采样速率.

使用可选的团队名称来打印日志 .

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

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

## 类型

### `CoreWebVitalsPayload`

```ts
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`

```ts
type InitCoreWebVitalsOptions = {
    isDev: boolean;

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

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

## 常见问题

### @guardian/core-web-vitals 是什么？

帮助实施Google核心网络维度的方法

### 如何安装 @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 和提交记录判断。

