# dir-glob 中文文档

规范地址：https://npmcn.com/package/dir-glob/

版本：3\.0\.1
npm 元数据更新时间：2022-06-15T04:24:36.942Z
中文译文更新时间：2026-11-05T16:25:47.894Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：5.4 kB，4 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=8
- 运行依赖：1 个
- 首次发布：2016-01-08T10:11:05.346Z
- 最新版本发布：2019-06-29T16:22:06.207Z
- 近 30 天下载量：209998007（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）

## 中文简介

将目录转换为相容的字符串

## 安装

```sh
npm install dir-glob
```

也可以使用：`pnpm add dir-glob`、`yarn add dir-glob`、`bun add dir-glob`

## README

# dir- glob 数据 [![Build Status](https://travis-ci.org/kevva/dir-glob.svg?branch=master)](https://travis-ci.org/kevva/dir-glob)

> 将目录转换为相容的字符串

## 安装

```
$ npm install dir-glob
```

## 使用量

```js
const dirGlob = require('dir-glob');

(async () => {
    console.log(await dirGlob(['index.js', 'test.js', 'fixtures']));
    //=> ['index.js', 'test.js', 'fixtures/**']

    console.log(await dirGlob(['index.js', 'inner_folder'], {cwd: 'fixtures'}));
    //=> ['index.js', 'inner_folder/**']

    console.log(await dirGlob(['lib/**', 'fixtures'], {
        files: ['test', 'unicorn']
        extensions: ['js']
    }));
    //=> ['lib/**', 'fixtures/**/test.js', 'fixtures/**/unicorn.js']

    console.log(await dirGlob(['lib/**', 'fixtures'], {
        files: ['test', 'unicorn', '*.jsx'],
        extensions: ['js', 'png']
    }));
    //=> ['lib/**', 'fixtures/**/test.{js,png}', 'fixtures/**/unicorn.{js,png}', 'fixtures/**/*.jsx']
})();
```

## API 密码

### dirGlob( 输入, 选项 )

回返a `Promise<string[]>` 带着花花公子.

### dirGlob.sync(输入,选项?)

回返a `string[]` 带着花花公子.

#### 投入

类型 : `string | string[]`

路径.

#### 选项

类型 : `object`

##### 扩展

类型 : `string[]`

将扩展添加到您 globs 的末尾 .

##### 文件

类型 : `string[]`

对某些文件只使用 glob .

##### 数据

类型 : `string[]`

在特定目录中测试 .

## 常见问题

### dir-glob 是什么？

将目录转换为相容的字符串

### 如何安装 dir-glob？

在项目目录运行 npm install dir-glob，或使用 pnpm add / yarn add / bun add。

### dir-glob 支持 TypeScript 吗？

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

### dir-glob 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=8。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### dir-glob 可以商用吗？

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

### dir-glob 的下载量有多少？

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

### dir-glob 还在维护吗？

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