# @activeprospect/indexer 中文文档

规范地址：https://npmcn.com/package/%40activeprospect/indexer/

版本：1\.3\.6
npm 元数据更新时间：2026-11-05T22:30:21.479Z
中文译文更新时间：2026-11-08T08:25:23.863Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：9.3 kB，8 个文件
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2015-05-05T14:48:19.887Z
- 最新版本发布：2022-05-16T16:06:46.287Z
- 近 30 天下载量：1854（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 0 个）

## 中文简介

将 Javascript 或 Coffeescript 文件的目录作为按文件名索引的模块

## 安装

```sh
npm install @activeprospect/indexer
```

也可以使用：`pnpm add @activeprospect/indexer`、`yarn add @activeprospect/indexer`、`bun add @activeprospect/indexer`

## README

## 索引器

这个Node.JS模块需要JavaScript(或CoffeeScript)文件的目录,并让相关的模块可用. 它可用于扩展指定的模块.

[![Build Status](https://travis-ci.org/activeprospect/indexer.svg)](https://travis-ci.org/activeprospect/indexer)

### 使用量

假设以下目录结构:

```
zoo
|-- ape.js
|-- donkey.js
|-- zebra.js
```

添加索引文件( E)`zoo/index.js`参加索引模块的代表:

```javascript
var path = require('path');

var index = require('indexer');

// index all the files in the same directory and extend this module
index(__dirname, module);
```

然后使用 `zoo` 模块 :

```javascript
var zoo = require('zoo');

zoo.ape    // returns the module defined in zoo/ape.js
zoo.donkey // returns the module defined in zoo/donkey.js
zoo.zebra  // returns the module defined in zoo/zebra.js
```

### 参考文献

此模块输出一个具有以下参数的单个函数:

-   `dirname` ——索引文件目录(.js和.coffee文件会被索引)
-   `module` - (可选)导出每个模块 `dirname` 到本单元.
-   `ignoreModules` ——向函数传递的其余参数为可忽略的模块名称 (即说. `index(__dirname, module 'ape', 'donkey')` 只导出 `zebra` 模块)

函数返回的对象在 `dirname`。 。 。 .

## 常见问题

### @activeprospect/indexer 是什么？

将 Javascript 或 Coffeescript 文件的目录作为按文件名索引的模块

### 如何安装 @activeprospect/indexer？

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

### @activeprospect/indexer 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/activeprospect\_\_indexer 是否存在。

### @activeprospect/indexer 可以商用吗？

@activeprospect/indexer 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @activeprospect/indexer 的下载量有多少？

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

### @activeprospect/indexer 还在维护吗？

最新版本 1\.3\.6 发布于 2022/05/17（4 年前）；至今共发布 14 个版本，其中过去 12 个月发布了 0 个；首次发布于 2015/05/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。