# @guardian/libs 中文文档

规范地址：https://npmcn.com/package/%40guardian/libs/

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

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

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

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

- 包体积（解压后）：150 kB，106 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@guardian/ophan-tracker-js ^2\.2\.10，tslib ^2\.8\.1，typescript ~6\.0\.3
- 首次发布：2020-10-06T09:19:05.341Z
- 最新版本发布：2026-06-10T10:20:46.857Z
- 近 30 天下载量：46378（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：539（近 12 个月 49 个）

## 中文简介

用于守护者的 JavaScript 库和类型

## 安装

```sh
npm install @guardian/libs
```

也可以使用：`pnpm add @guardian/libs`、`yarn add @guardian/libs`、`bun add @guardian/libs`

## README

# `@guardian/libs`

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

> 用于守护者的 JavaScript 库和类型

### [`ArticleElementRole`](https://npmcn.com/package/%40guardian/libs/src/ArticleElementRole)

描述文章中元素作用的类型.

### [同意](https://npmcn.com/package/%40guardian/libs/src/consent-management-platform)

卫报同意管理平台.

### [饼干](https://npmcn.com/package/%40guardian/libs/src/cookies)

API 结束 `document.cookies`。 。 。 .

### [国家](https://npmcn.com/package/%40guardian/libs/src/countries)

国家数据及获取数据的方法.

### [格式](https://npmcn.com/package/%40guardian/libs/src/format)

编译编辑设计和信息架构.

### [语言](https://npmcn.com/package/%40guardian/libs/src/locale)

获取用户当前位置 .

### [开关](https://npmcn.com/package/%40guardian/libs/src/switches)

获取当前开关在guardian.com上.

### [`isBoolean`](https://npmcn.com/package/%40guardian/libs/src/isBoolean)

检查一个值是否为布尔值 .

### [`isNonNullable`](https://npmcn.com/package/%40guardian/libs/src/isNonNullable)

检查一个值是否是一个 [`NonNullable`](https://www.typescriptlang.org/docs/handbook/utility-types.html#nonnullabletype)。 。 。 .

### [`isObject`](https://npmcn.com/package/%40guardian/libs/src/isObject)

检查一个值是否为平面对象(即:. `{}`\- 喜欢.

### [`isOneOf`](https://npmcn.com/package/%40guardian/libs/src/isOneOf)

检查一个值是一组字串还是数字 .

### [`isString`](https://npmcn.com/package/%40guardian/libs/src/isString)

检查一个值是否为字符串 .

### [`isUndefined`](https://npmcn.com/package/%40guardian/libs/src/isUndefined)

检查一个值是否是 `undefined`。 。 。 .

### [`joinUrl`](https://npmcn.com/package/%40guardian/libs/src/joinUrl)

将独立的 url 部件合并为一个有效的 url 字符串.

### [`loadScript`](https://npmcn.com/package/%40guardian/libs/src/loadScript)

输入外部 JavaScript 文件 .

### [`log`, (中文(简体) ), `debug`](https://npmcn.com/package/%40guardian/libs/src/logger)

选择登录团队特定消息到控制台.

### [欧芬](https://npmcn.com/package/%40guardian/libs/src/@types/ophan)

与Ophan有关的类型.

### [业绩](https://npmcn.com/package/%40guardian/libs/src/performance)

API 结束 `window.performance` 钩入 [`log`](https://npmcn.com/package/%40guardian/libs/src/logger) 数据仓库.

### [`storage`](https://npmcn.com/package/%40guardian/libs/src/storage)

强力API结束 `localStorage` 财务报告和审定财务报表 `sessionStorage`。 。 。 .

### [`timeAgo`](https://npmcn.com/package/%40guardian/libs/src/timeAgo)

将绝对日期格式化为时间符号字符串.

### [`getErrorMessage`](https://npmcn.com/package/%40guardian/libs/src/getErrorMessage)

从可以丢入JavaScript的 Errors(或其他值) 中提取有用错误消息的工具.

## 安装

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

```bash
yarn add @guardian/libs
```

或者说

```bash
npm install @guardian/libs
```

接下来

```js
import { loadScript, storage, ...etc } from '@guardian/libs';
```

### 捆绑

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

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

### 使用链接进行本地测试

1.  在终端的命令行中,导航到 Csnx 根目录 。 运行 :

```sh
make @guardian/libs:build
```

此构建命令必须重新运行, 才能获取更改 .

2.  导航到将测试代码更改的 repo 。 在相应的文件夹中, 运行

```sh
npm/yarn/pnpm link ../csnx/libs/@guardian/libs
```

在哪里“./csnx”是您在csnx中本地变化的路径,您将csnx代码复制到那里.

在步骤 1 中重建 “ @ guardian/ libs ” 后, 此命令无需重复, 更改会被自动取出 .

3.  一旦你开发了自己的修改和测试,你可以与正在测试修改的Repo脱钩

```sh
npm/yarn/pnpm unlink ../csnx/libs/@guardian/libs
```

## 常见问题

### @guardian/libs 是什么？

用于守护者的 JavaScript 库和类型

### 如何安装 @guardian/libs？

在项目目录运行 npm install @guardian/libs，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@guardian/ophan-tracker-js（^2\.2\.10）、tslib（^2\.8\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @guardian/libs 支持 TypeScript 吗？

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

### @guardian/libs 支持 ESM 还是 CommonJS？

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

### @guardian/libs 可以商用吗？

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

### @guardian/libs 的下载量有多少？

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

### @guardian/libs 还在维护吗？

最新版本 33\.0\.0 发布于 2026/06/10（5 个月前）；至今共发布 539 个版本，其中过去 12 个月发布了 49 个；首次发布于 2020/10/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

