# @blex41/word-search 中文文档

规范地址：https://npmcn.com/package/%40blex41/word-search/

版本：1\.2\.0
npm 元数据更新时间：2022-04-04T19:32:13.045Z
中文译文更新时间：2026-11-08T06:45:09.582Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：83.3 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2018-12-09T14:43:05.394Z
- 最新版本发布：2021-06-15T22:14:39.830Z
- 近 30 天下载量：2973（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 0 个）

## 中文简介

文字搜索谜题生成器

## 安装

```sh
npm install @blex41/word-search
```

也可以使用：`pnpm add @blex41/word-search`、`yarn add @blex41/word-search`、`bun add @blex41/word-search`

## README

# 字词搜索

[![Build Status](https://travis-ci.com/blex41/word-search.svg?branch=master)](https://travis-ci.com/blex41/word-search) [![Coverage Status](https://coveralls.io/repos/github/blex41/word-search/badge.svg?branch=master)](https://coveralls.io/github/blex41/word-search?branch=master)

文字搜索谜题生成器 .

## 安装

与节点JS:

```
npm install -S @blex41/word-search
```

...然后说:

```javascript
const WordSearch = require("@blex41/word-search");
```

在浏览器中 :

```html
<script src="https://unpkg.com/@blex41/word-search@latest/dist/wordsearch.min.js"></script>
<script>
  /* WordSearch is available here */
</script>
```

## 使用量

```javascript
// If an option is missing, it will be given a default value
const options = {
  cols: 6,
  rows: 6,
  disabledDirections: ["N", "W", "NW", "SW"],
  dictionary: ["Hello", "crêpe", "Škoda", "word", "search"],
  maxWords: 20,
  backwardsProbability: 0.3,
  upperCase: true,
  diacritics: true
};

// Create a new puzzle
const ws = new WordSearch(options);

// Use its methods
console.log(ws.toString());
// S Š M Y W X
// E C K M O G
// A R Z O R A
// R Ê N F D I
// C P I Y Q A
// H E L L O I
```

## 选项

以下是您在创建新谜题时可以通过的选项 :

| 名称 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| 缩写 | 整数 | `10` | 列数 |
| 行数 | 整数 | `10` | 行数 |
| 已禁用 方向 | 阵阵. 字符串 | `[]` | 禁用方向(任何"N","S","E","W","NE","NW","SE"或"SW") |
| 词典 | 阵阵. 字符串 | `[]` | 要插入网格的单词( 有些单词如果太长, 无法放置, 或者如果超过最大值的话, 可能不会插入) |
| 最大字数 | 整数 | `20` | 要插入的最大字数 |
| 倒转概率 | 浮动 | `0.3` | 每个字都倒写的可能性(这是一个概率,而不是严格的百分比) |
| 大写 | 布尔 | `true` | 网格中的字母是否为大写 |
| 二次批评 | 布尔 | `false` | 网格中的字母是否应当保留其二极管( accents) |
| 被禁词 | 阵阵. 字符串 | `[]` | 不应意外出现在最终网格中的任何方向(如:亵渎)的词. 将尝试重建它 `maxRetries` |
| 最大存储量 | 整数 | `10` | 仅用于 `forbiddenWords` 选项 - 在网格中找到被禁词时应进行多少次重建 |

## 属性和方法

一旦创建了您的实例, 您可以访问这些 Read- Only 属性 :

### 网络

返回谜题的网格

```json
[
  ["S", "Š", "M", "Y", "W", "X"],
  ["E", "C", "K", "M", "O", "G"],
  ["A", "R", "Z", "O", "R", "A"],
  ["R", "Ê", "N", "F", "D", "I"],
  ["C", "P", "I", "Y", "Q", "A"],
  ["H", "E", "L", "L", "O", "I"]
]
```

### 单词

返回已成功插入网格的单词 :

```javascript
[
  {
    word: "word",
    clean: "WORD",
    path: [
      { x: 4, y: 0 }, // W
      { x: 4, y: 1 }, // O
      { x: 4, y: 2 }, // R
      { x: 4, y: 3 } // D
    ]
  },
  {
    word: "crêpe",
    clean: "CRÊPE",
    path: [
      { x: 1, y: 1 }, // C
      { x: 1, y: 2 }, // R
      { x: 1, y: 3 }, // Ê
      { x: 1, y: 4 }, // P
      { x: 1, y: 5 } // E
    ]
  }
  /* ... */
];
```

### ws. forbidden Words 包含

返回一组被禁词,这些被插入到网格中,因为之后找不到其他解决方案 `maxRetries`数字 :

```javascript
["CRAP"]
```

您也可以使用这些方法:

### ws.dump () (英语)

返回代表谜题状态的对象。 如果您想要保存一个游戏, 并在稍后使用此游戏再使用, 此选项会有所帮助 `ws.load(backup)`。 。 。 .

### ws.load( 备份)

从上一个垃圾堆的物体上装入游戏.

```javascript
const ws1 = new WordSearch(/* ... */);
const backup = ws1.dump();
const ws2 = new WordSearch().load(backup);
// ws2 is now a copy of ws1
```

### ws. to String () (中文(简体) )

返回代表谜题网格的字符串。 如果您想将其打印到控制台上, 这会有所帮助 .

```
S Š M Y W X
E C K M O G
A R Z O R A
R Ê N F D I
C P I Y Q A
H E L L O I
```

### ws.read(开始,结束)

读取来自 `start` 改为 `end` 位置并返回其构成的字符串。 这可用于检查用户突出显示的字母 .

```javascript
ws.read({ x: 1, y: 0 }, { x: 5, y: 4 }); // "ŠKODA"
```

## 常见问题

### @blex41/word-search 是什么？

文字搜索谜题生成器

### 如何安装 @blex41/word-search？

在项目目录运行 npm install @blex41/word-search，或使用 pnpm add / yarn add / bun add。

### @blex41/word-search 支持 TypeScript 吗？

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

### @blex41/word-search 支持 ESM 还是 CommonJS？

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

### @blex41/word-search 可以商用吗？

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

### @blex41/word-search 的下载量有多少？

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

### @blex41/word-search 还在维护吗？

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