wikiparser-node 1.13.1-b → 1.13.1

package/dist/src/transclude.d.ts

@@ -0,0 +1,159 @@
+import Parser from '../index';
+import { Token } from './index';
+import { ParameterToken } from './parameter';
+import { AtomToken } from './atom';
+import { SyntaxToken } from './syntax';
+import type { LintError } from '../base';
+/**
+ * 模板或魔术字
+ * @classdesc `{childNodes: [AtomToken|SyntaxToken, ...AtomToken, ...ParameterToken]}`
+ */
+export declare abstract class TranscludeToken extends Token {
+    #private;
+    readonly modifier: string;
+    readonly name: string;
+    readonly childNodes: readonly [AtomToken | SyntaxToken, ...ParameterToken[]] | readonly [SyntaxToken, AtomToken, AtomToken, ...ParameterToken[]];
+    abstract get firstChild(): AtomToken | SyntaxToken;
+    abstract get lastChild(): AtomToken | SyntaxToken | ParameterToken;
+    abstract get children(): [AtomToken | SyntaxToken, ...ParameterToken[]] | [SyntaxToken, AtomToken, AtomToken, ...ParameterToken[]];
+    abstract get firstElementChild(): AtomToken | SyntaxToken;
+    abstract get lastElementChild(): AtomToken | SyntaxToken | ParameterToken;
+    get type(): 'template' | 'magic-word';
+    /** 是否存在重复参数 */
+    get duplication(): boolean;
+    set duplication(duplication: boolean);
+    /**
+     * @param title 模板标题或魔术字
+     * @param parts 参数各部分
+     * @throws `SyntaxError` 非法的模板名称
+     */
+    constructor(title: string, parts: ([string] | [string | number, string])[], config?: Parser.Config, accum?: Token[]);
+    /**
+     * 设置引用修饰符
+     * @param modifier 引用修饰符
+     */
+    setModifier(modifier: string): boolean;
+    /** 是否是模板或模块 */
+    isTemplate(): boolean;
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     */
+    insertAt<T extends ParameterToken>(token: T, i?: number): T;
+    /** 获取所有参数 */
+    getAllArgs(): ParameterToken[];
+    /** 获取所有匿名参数 */
+    getAnonArgs(): ParameterToken[];
+    /**
+     * 获取指定参数
+     * @param key 参数名
+     * @param exact 是否匹配匿名性
+     * @param copy 是否返回一个备份
+     */
+    getArgs(key: string | number, exact?: boolean, copy?: boolean): Set<ParameterToken>;
+    /**
+     * 获取重名参数
+     * @throws `Error` 仅用于模板
+     */
+    getDuplicatedArgs(): [string, ParameterToken[]][];
+    /**
+     * 对特定魔术字获取可能的取值
+     * @throws `Error` 不是可接受的魔术字
+     */
+    getPossibleValues(): Token[];
+    cloneNode(): this;
+    /** 替换引用 */
+    subst(): void;
+    /** 安全的替换引用 */
+    safesubst(): void;
+    /**
+     * @override
+     * @param i 移除位置
+     */
+    removeAt(i: number): ParameterToken;
+    /**
+     * 是否具有某参数
+     * @param key 参数名
+     * @param exact 是否匹配匿名性
+     */
+    hasArg(key: string | number, exact?: boolean): boolean;
+    /**
+     * 获取生效的指定参数
+     * @param key 参数名
+     * @param exact 是否匹配匿名性
+     */
+    getArg(key: string | number, exact?: boolean): ParameterToken | undefined;
+    /**
+     * 移除指定参数
+     * @param key 参数名
+     * @param exact 是否匹配匿名性
+     */
+    removeArg(key: string | number, exact?: boolean): void;
+    /** 获取所有参数名 */
+    getKeys(): string[];
+    /**
+     * 获取参数值
+     * @param key 参数名
+     */
+    getValues(key: string | number): string[];
+    /**
+     * 获取生效的参数值
+     * @param key 参数名
+     */
+    getValue(): Record<string, string>;
+    getValue(key: string | number): string | undefined;
+    /**
+     * 插入匿名参数
+     * @param val 参数值
+     */
+    newAnonArg(val: string): ParameterToken;
+    /**
+     * 设置参数值
+     * @param key 参数名
+     * @param value 参数值
+     * @throws `Error` 仅用于模板
+     */
+    setValue(key: string, value: string): void;
+    /**
+     * 将匿名参数改写为命名参数
+     * @throws `Error` 仅用于模板
+     */
+    anonToNamed(): void;
+    /**
+     * 替换模板名
+     * @param title 模板名
+     * @throws `Error` 仅用于模板
+     */
+    replaceTemplate(title: string): void;
+    /**
+     * 替换模块名
+     * @param title 模块名
+     * @throws `Error` 仅用于模块
+     */
+    replaceModule(title: string): void;
+    /**
+     * 替换模块函数
+     * @param func 模块函数名
+     * @throws `Error` 仅用于模块
+     * @throws `Error` 尚未指定模块名称
+     */
+    replaceFunction(func: string): void;
+    /**
+     * 重复参数计数
+     * @throws `Error` 仅用于模板
+     */
+    hasDuplicatedArgs(): number;
+    /**
+     * 修复重名参数：
+     * `aggressive = false`时只移除空参数和全同参数，优先保留匿名参数，否则将所有匿名参数更改为命名。
+     * `aggressive = true`时还会尝试处理连续的以数字编号的参数。
+     * @param aggressive 是否使用有更大风险的修复手段
+     */
+    fixDuplication(aggressive?: boolean): string[];
+    /**
+     * 转义模板内的表格
+     * @throws `Error` 转义失败
+     */
+    escapeTables(): TranscludeToken;
+}