Typo.js 技术文档

1. 安装指南

1.1 在 Chrome 扩展中使用

将 typo.js 文件包含在您的扩展程序的背景页面中。

1.2 在标准 Web 应用程序中使用

在标准 Web 应用程序中，您需要传递一个设置对象，该对象提供了一个指向包含所需字典的文件夹的路径。

1.3 在 Node.js 中使用

在 Node.js 中，使用以下方式加载：

var Typo = require("typo-js");
var dictionary = new Typo([...]);

2. 项目的使用说明

2.1 初始化字典

在 Chrome 扩展中，初始化字典如下：

var dictionary = new Typo("en_US");

在标准 Web 应用程序中，初始化字典如下：

var dictionary = new Typo("en_US", false, false, { dictionaryPath: "typo/dictionaries" }),

2.2 检查单词拼写

要检查一个单词是否拼写正确，使用以下方法：

var is_spelled_correctly = dictionary.check("mispelled");

2.3 获取拼写建议

要为拼写错误的单词获取建议，使用以下方法：

var array_of_suggestions = dictionary.suggest("mispeling");

// array_of_suggestions == ["misspelling", "dispelling", "misdealing", "misfiling", "misruling"]

2.4 Hunspell affix 标志支持

Typo.js 完全支持以下 Hunspell affix 标志：

• PFX
• SFX
• REP
• FLAG
• COMPOUNDMIN
• COMPOUNDRULE
• ONLYINCOMPOUND
• KEEPCASE
• NOSUGGEST
• NEEDAFFIX

3. 项目 API 使用文档

请参考项目在 GitHub 上的官方仓库文档以获取详细的 API 使用说明。

4. 项目安装方式

要修改 Typo.js，请对 ts/typo.ts 文件进行更改，然后运行 build.sh 脚本来生成 JavaScript 文件 typo/typo.js。