# nwsapi 中文文档

规范地址：https://npmcn.com/package/nwsapi/

版本：2\.2\.28
npm 元数据更新时间：2026-09-18T19:18:27.712Z
中文译文更新时间：2026-11-05T16:24:57.539Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/nwsapi
原文对照：https://npmcn.com/package/nwsapi/?lang=original
项目主页：https://javascript.nwbox.com/nwsapi/
源码仓库：https://github.com/dperini/nwsapi

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

- 包体积（解压后）：104 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2018-03-28T16:50:42.289Z
- 最新版本发布：2026-09-18T19:18:27.511Z
- 近 30 天下载量：213925448（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：47（近 12 个月 6 个）

## 中文简介

快速 CSS 选择器 API 引擎

## 安装

```sh
npm install nwsapi
```

也可以使用：`pnpm add nwsapi`、`yarn add nwsapi`、`bun add nwsapi`

## README

# [西北](http://dperini.github.io/nwsapi/)

快速 CSS 选择器 API 引擎

![](https://img.shields.io/npm/v/nwsapi.svg?colorB=orange&style=flat) ![](https://img.shields.io/github/tag/dperini/nwsapi.svg?style=flat) ![](https://img.shields.io/npm/dw/nwshttps://ko-fi.com/dperiniapi.svg?style=flat) ![](https://img.shields.io/github/issues/dperini/nwsapi.svg?style=flat)

NWSAPI是发展进步 [海军少将](https://github.com/dperini/nwmatcher) 目标 [选择器等级 4](https://www.w3.org/TR/selectors-4/) 符合规定。 它经过了彻底的重修,便于扩展和维护。 它是一个右到左选择器解析器和编译器,用纯 Javascript 书写,没有外部依赖性 。 它最初被认为是一个交叉浏览器库来改进事件授权和各个框架中的网页刮取,但它已经成为了较新的浏览器和无头环境中本地CSS选择和匹配功能的流行取而代之.

用这个 [正则表达式](https://en.wikipedia.org/wiki/Regular_expression) 来解析 CSS 选择字符串和 [元编程](https://en.wikipedia.org/wiki/Metaprogramming) 将这些选择的字符串转换为 Javascript 函数解析器。 此进程只针对每个选择器字符串执行一次,允许对函数解析器进行记忆并实现无比的性能.

## 安装

将NWSAPI纳入标准网页:

```html
<script type="text/javascript" src="nwsapi.js"></script>
```

将 NWSAPI 列入标准网页并自动替换本地的 QSA :

```html
<script type="text/javascript" src="nwsapi.js" onload="NW.Dom.install()"></script>
```

使用 NWSAPI 与节点.js :

```
$ npm install nwsapi
```

NWSAPI目前支持浏览器(作为一个全局, `NW.Dom`)和无头环境(作为普通JS模块).

## 支持的选择器

以下是所有CSS2/CSS3/CSS4的列表 [支持的选择者](https://github.com/dperini/nwsapi/wiki/CSS-supported-selectors)。 。 。 .

## 特征和遵守情况

你可以读更多关于NWSAPI的 [特性和遵守情况](https://github.com/dperini/nwsapi/wiki/Features-and-compliance) 在维基百科上.

## API 密码

### DOM 选择

#### `ancestor( selector, context, callback )`

返回最近的祖先元素匹配的引用 `selector`,从 `context`. 回归 `null` 如果没有找到元素。 若为 `callback` 为匹配的元素而引用.

#### `first( selector, context, callback )`

返回第一个元素匹配的引用 `selector`,从 `context`. 回归 `null` 如果没有元素匹配。 若为 `callback` 为匹配的元素而引用.

#### `match( selector, element, callback )`

回返 `true` 若为 `element` 匹配 `selector`,从 `context`; 返回 `false` 否则。 若为 `callback` 为匹配的元素而引用.

#### `select( selector, context, callback )`

返回匹配的所有元素的数组 `selector`,从 `context`; 返回为空 `Array` 否则。 若为 `callback` ,每个匹配元素都引用它.

### DOM 帮助者

#### `byId( id, from )`

返回带有标识的第一个元素的引用 `id`,可选择过滤到元素的后人 `from`。 。 。 .

#### `byTag( tag, from )`

返回带有指定标签名的元素数组 `tag`,可选择过滤到元素的后人 `from`。 。 。 .

#### `byClass( class, from )`

返回具有指定类名的元素数组 `class`,可选择过滤到元素的后人 `from`。 。 。 .

### 引擎配置

#### `configure( options )`

以下是当前可用的配置选项列表,它们的默认值和描述,它们是布尔标记,可以设定为 `true` 或者说 `false`数字 :

-   `IDS_DUPES`: true - 允许使用具有相同代号的多个元素的真伪, 虚假的不可允许
-   `LIVECACHE`: 真实 - 对缓存结果和解析者都是真实的, 对缓存结果和解析者都是虚假的
-   `MIXEDCASE`: true - 匹配标签名大小写不敏感, 虚假以匹配使用大小写敏感
-   `LOGERRORS`: 真实 - 向控制台打印错误和警告的真实性

### 扩展基本功能的实例

#### `configure( { <configuration-flag>: [ true | false ] } )`

禁用日志错误/ 警告控制台, 不允许重复 ID 。 示例

```js
NW.Dom.configure( { LOGERRORS: false, IDS_DUPES: false } );
```

注:无参数的 NW.Dom.confit () 返回当前配置.

#### `registerCombinator( symbol, resolver )`

在组合符表格中注册新符号及其匹配的解析器。 示例

```js
NW.Dom.registerCombinator( '^', 'e.parentElement' );
```

#### `registerOperator( symbol, resolver )`

在属性运算符表中注册新符号及其匹配的解析器。 示例

```js
NW.Dom.registerOperator( '!=', { p1: '^', p2: '$', p3: 'false' } );
```

#### `registerSelector( name, rexp, func )`

在选择器表格中注册新选择器、匹配的RE和解析器函数。 示例

```js
NW.Dom.registerSelector('Controls', /^\:(control)(.*)/i,
  (function(global) {
    return function(match, source, mode, callback) {
      var status = true;
      source = 'if(/^(button|input|select|textarea)/i.test(e.nodeName)){' + source + '}';
      return { 'source': source, 'status': status };
    };
  })(this));
```

## 支持和赞助

**西北** 每天有数百万个建筑、网络拆解机和测试套房——包括关键基础设施,例如: [日记](https://github.com/jsdom/jsdom)。 。 。 .

保持零依赖性,超快CSS引擎,严格遵循不断发展的W3C选择器规格,需要大量时间,研究和测试. 如果NWSAPI帮助你的公司节省时间,建立特性,或者进行可靠的测试, **请考虑支持其持续维护!**

### 为什么赞助?

-   **对于开发者:** 保持项目积极维护,无臭虫,并先于新的浏览器标准更新.
-   **对于企业:** 确保工具链中关键依赖者的稳定和长期安全.

### 帮助的方法

选择最适合您或您的组织的平台 :

-   **[GitHub 赞助商](https://github.com/sponsors/dperini)数字 :** 月级赞助直接在GitHub上.
-   **[开放集体](https://opencollective.com/nwsapi)数字 :** 公开源码项目资金透明,企业支持理想.
-   **[帕特伦](https://www.patreon.com/dperini)数字 :** 每月定期提供支持,并给予支持者奖励.
-   **[高飞](https://ko-fi.com/dperini)数字 :** 快速一次性提示或经常性的微捐赠.
-   **[给我买杯咖啡](https://www.buymeacoffee.com/dperini)数字 :** 快速,临时一次性捐赠.
-   **[解放组织](https://liberapay.com/dperini)数字 :** 经常性零费开源支持.
-   **[问题Hunt](https://issuehunt.io/r/dperini/nwsapi)数字 :** 资助特定特征或bug bountys.

* * *

_自定义许可,专用支持,或优先bug修正也提供给公司赞助商. 随便你!_

## 常见问题

### nwsapi 是什么？

快速 CSS 选择器 API 引擎

### 如何安装 nwsapi？

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

### nwsapi 支持 TypeScript 吗？

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

### nwsapi 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### nwsapi 可以商用吗？

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

### nwsapi 的下载量有多少？

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

### nwsapi 还在维护吗？

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