# @adobe/helix-shared-indexer 中文文档

规范地址：https://npmcn.com/package/%40adobe/helix-shared-indexer/

版本：2\.2\.11
npm 元数据更新时间：2026-10-27T07:26:23.399Z
中文译文更新时间：2026-11-05T20:24:43.918Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：65.6 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：8 个
- 首次发布：2021-11-30T17:55:14.463Z
- 最新版本发布：2026-10-27T07:26:22.840Z
- 近 30 天下载量：28749（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：107（近 12 个月 6 个）

## 中文简介

Helix 项目共享模块 - 索引器

## 安装

```sh
npm install @adobe/helix-shared-indexer
```

也可以使用：`pnpm add @adobe/helix-shared-indexer`、`yarn add @adobe/helix-shared-indexer`、`bun add @adobe/helix-shared-indexer`

## README

# 螺旋共享 - 索引器

## 参考文献

在你身边 `helix-query.yaml` [1个](https://npmcn.com/package/%40adobe/helix-shared-indexer/#readme-footnote1),可以定义一个或多个索引定义。 抽样指数定义如下:

```
indices:
  mysite:
    source: html
    fetch: https://{ref}--{repo}--{owner}.project-helix.page/{path}
    properties:
      author:
        select: main > div:nth-of-type(3) > p:nth-of-type(1)
        value: |
          match(el, 'by (.*)')
```

这个 `select` 属性是一个从文档中抓取 HTML 元素的 CSS 选择器。 验证 CSS 选择器是否输入 您可以在浏览器的 Javascript 控制台中测试它, 例如用于 `author` 上面显示的选择器, 输入以下表达式:

```
document.querySelectorAll('main > div:nth-of-type(3) > p:nth-of-type(1)');
```

这个 `value` 或者说 `values` 属性包含一个应用到所选择的所有 HTML 元素的表达式。 属性名称 `value` 首选项 当你需要弦, `values` 另一方面,为您提供了所有找到的匹配的阵列。 表达式可以包含 函数和变量组合:

### 内置HTML( el)

返回元素的 HTML 内容.

### 文本 Content( el)

返回选定元素的文本内容及其所有后人.

### 属性( el, 名称)

返回带有指定元素名称的属性值.

### 匹配( el, re)

匹配含有括号的正则表达式,以捕获通过元素中的项目. 在那个 `author` 实例(如上文) `<p>` 选中的元素可能 包含 `by James Brown`,因此它会捕捉所有后续 `by` 。 。 。 .

### 单词( el, start, end)

对于取笑者有用,此选项从 HTML 元素中选择一个字段 .

### 替换( el, substr, 新Substr)

将文本中子字符串的所有出错替换为替换.

### 解析时标( el, 格式)

解析一个作为字符串给出的时间戳,并返回其自1970年1月1日以来的秒数值.

### 尔

返回 HTML 元素 `select` 属性.

### 路径

返回正在索引的 HTML 文档的路径.

### 页眉\[名\]

在获取 HTML 文档时,返回带有指定名称的 HTTP 响应头的值.

\[1\] (中文(简体) ): 定义 `helix-query.yaml` 这里有: [https://github.com/adobe/helix-shared/blob/main/docs/indexconfig.md 互联网档案馆的存檔,存档日期2014-12-21](https://github.com/adobe/helix-shared/blob/main/docs/indexconfig.md)

## 常见问题

### @adobe/helix-shared-indexer 是什么？

Helix 项目共享模块 - 索引器

### 如何安装 @adobe/helix-shared-indexer？

在项目目录运行 npm install @adobe/helix-shared-indexer，或使用 pnpm add / yarn add / bun add。

### @adobe/helix-shared-indexer 支持 TypeScript 吗？

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

### @adobe/helix-shared-indexer 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @adobe/helix-shared-indexer 可以商用吗？

@adobe/helix-shared-indexer 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @adobe/helix-shared-indexer 的下载量有多少？

根据 npm 官方下载统计，@adobe/helix-shared-indexer 在 2026/10/05 – 2026/11/03 这 30 天内被下载 28,749 次，日均约 958 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @adobe/helix-shared-indexer 还在维护吗？

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