@scml/mod-twee-replacer

Twee replacer 的 TypeScript 类型定义，对 Twee 段落内容执行查找/替换。

安装

npm

yarn

pnpm

bun

deno

npm install -D @scml/mod-twee-replacer

快速开始

添加类型引用

/// <reference types="@scml/mod-twee-replacer" />

使用全局实例

addonTweeReplacer 已挂载到 window 上。

按需导入类型

import type { TweeReplacer, ReplaceParams, ReplaceInfo } from '@scml/mod-twee-replacer/TweeReplacer';

全局类型 global

属性	类型	说明
`addonTweeReplacer`	`TweeReplacer`	Addon 实例，执行 Twee 替换

主入口

子路径导入

/// <reference types="@scml/mod-twee-replacer" />

子路径导出

子路径	描述
`.`	主入口，增强 Window/全局
`./TweeReplacer`	主类、ReplaceParams、ReplaceInfo 等

API 参考

./TweeReplacer

TweeReplacer 类

属性/方法	说明
`info`	`Map<string, ReplaceInfo>`
`registerMod()`	注册 mod
`enableLinkerMode()`	启用 linker 模式
`afterEarlyLoad()`	EarlyLoad 后钩子
`afterPatchModToGame()`	patch 后钩子
`do_patch()`	执行替换
`init()`	初始化

ReplaceParams 接口

属性	类型	说明
`passage`	`string`	passage 名
`findString`	`string`	查找字符串
`findRegex`	`string`	查找正则
`regexFlag`	`string`	正则标志
`replace`	`string`	替换字符串
`replaceFile`	`string`	替换文件路径
`debug`	`boolean`	调试
`all`	`boolean`	替换全部

类型定义来源

源码

INFO

上游: https://github.com/Lyoko-Jeremie/Degrees-of-Lewdity_Mod_TweeReplacer
默认分支: master
构建: pnpm run download && pnpm run build

#@scml/mod-twee-replacer

#安装

#快速开始

#添加类型引用

#使用全局实例

#按需导入类型

#全局类型 global

#子路径导出

#API 参考

#./TweeReplacer

#TweeReplacer 类

#ReplaceParams 接口

#类型定义来源

@scml/mod-twee-replacer

安装

快速开始

添加类型引用

使用全局实例

按需导入类型

全局类型 global

子路径导出

API 参考

./TweeReplacer

TweeReplacer 类

ReplaceParams 接口

类型定义来源