wikiparser-node 0.11.0-m → 0.11.0

package/dist/src/index.d.ts

@@ -7,15 +7,22 @@ declare class Token extends AstElement {
     /**
      * @param {string} wikitext wikitext
      * @param {import('../../typings/token').accum} accum
+     * @param {acceptable} acceptable 可接受的子节点设置
      */
-    constructor(wikitext: string, config?: import("../../typings/token").ParserConfig, halfParsed?: boolean, accum?: import('../../typings/token').accum, acceptable?: any);
+    constructor(wikitext: string, config?: import("../../typings/token").ParserConfig, halfParsed?: boolean, accum?: import('../../typings/token').accum, acceptable?: acceptable);
+    /** 所有图片，包括图库 */
+    get images(): Token[];
+    /** 所有内链、外链和自由外链 */
+    get links(): Token[];
+    /** 所有模板和模块 */
+    get embeds(): Token[];
     /**
      * @override
      * @template {string} T
      * @param {T} key 属性键
      * @param {TokenAttribute<T>} value 属性值
      */
-    override setAttribute<T extends string>(key: T, value: import("../../typings/node").TokenAttribute<T>): Token;
+    override setAttribute<T extends string>(key: T, value: import("../../typings/node").TokenAttribute<T>): Token | this;
     /** 是否是普通节点 */
     isPlain(): boolean;
     /**
@@ -25,6 +32,7 @@ declare class Token extends AstElement {
      * @param {number} i 插入位置
      * @complexity `n`
      * @returns {T extends Token ? Token : AstText}
+     * @throws `RangeError` 不可插入的子节点
      */
     override insertAt<T_1 extends string | Token>(token: T_1, i?: number): T_1 extends Token ? Token : AstText;
     /**
@@ -35,6 +43,130 @@ declare class Token extends AstElement {
      * @param {boolean} selfLink 是否允许selfLink
      */
     normalizeTitle(title: string, defaultNs?: number, halfParsed?: boolean, decode?: boolean, selfLink?: boolean): import("../lib/title");
+    /**
+     * @override
+     * @param {number} i 移除位置
+     * @returns {Token}
+     * @complexity `n`
+     * @throws `Error` 不可移除的子节点
+     */
+    override removeAt(i: number): Token;
+    /**
+     * 替换为同类节点
+     * @param {Token} token 待替换的节点
+     * @complexity `n`
+     * @throws `Error` 不存在父节点
+     * @throws `Error` 待替换的节点具有不同属性
+     */
+    safeReplaceWith(token: Token): void;
+    /**
+     * 创建HTML注释
+     * @param {string} data 注释内容
+     */
+    createComment(data?: string): import("./nowiki/comment");
+    /**
+     * 创建标签
+     * @param {string} tagName 标签名
+     * @param {{selfClosing: boolean, closing: boolean}} options 选项
+     * @throws `RangeError` 非法的标签名
+     */
+    createElement(tagName: string, { selfClosing, closing }?: {
+        selfClosing: boolean;
+        closing: boolean;
+    }): any;
+    /**
+     * 创建纯文本节点
+     * @param {string} data 文本内容
+     */
+    createTextNode(data?: string): AstText;
+    /**
+     * 找到给定位置所在的节点
+     * @param {number} index 位置
+     */
+    caretPositionFromIndex(index: number): {
+        offsetNode: Token;
+        offset: number;
+    };
+    /**
+     * 找到给定位置所在的节点
+     * @param {number} x 列数
+     * @param {number} y 行数
+     */
+    caretPositionFromPoint(x: number, y: number): {
+        offsetNode: Token;
+        offset: number;
+    };
+    /**
+     * 找到给定位置所在的最外层节点
+     * @param {number} index 位置
+     * @throws `Error` 不是根节点
+     */
+    elementFromIndex(index: number): this;
+    /**
+     * 找到给定位置所在的最外层节点
+     * @param {number} x 列数
+     * @param {number} y 行数
+     */
+    elementFromPoint(x: number, y: number): this;
+    /**
+     * 找到给定位置所在的所有节点
+     * @param {number} index 位置
+     */
+    elementsFromIndex(index: number): Token[];
+    /**
+     * 找到给定位置所在的所有节点
+     * @param {number} x 列数
+     * @param {number} y 行数
+     */
+    elementsFromPoint(x: number, y: number): Token[];
+    /**
+     * 判断标题是否是跨维基链接
+     * @param {string} title 标题
+     */
+    isInterwiki(title: string): RegExpMatchArray;
+    /**
+     * 深拷贝所有子节点
+     * @complexity `n`
+     * @returns {(AstText|Token)[]}
+     */
+    cloneChildNodes(): (AstText | Token)[];
+    /**
+     * 深拷贝节点
+     * @complexity `n`
+     * @throws `Error` 未定义复制方法
+     */
+    cloneNode(): Token;
+    /**
+     * 获取全部章节
+     * @complexity `n`
+     */
+    sections(): (Token | AstText)[][];
+    /**
+     * 获取指定章节
+     * @param {number} n 章节序号
+     * @complexity `n`
+     */
+    section(n: number): (Token | AstText)[];
+    /**
+     * 获取指定的外层HTML标签
+     * @param {string|undefined} tag HTML标签名
+     * @returns {[Token, Token]}
+     * @complexity `n`
+     * @throws `RangeError` 非法的标签或空标签
+     */
+    findEnclosingHtml(tag: string | undefined): [Token, Token];
+    /**
+     * 获取全部分类
+     * @complexity `n`
+     */
+    getCategories(): any[][];
+    /**
+     * 重新解析单引号
+     * @throws `Error` 不接受QuoteToken作为子节点
+     */
+    redoQuotes(): void;
+    /** 解析部分魔术字 */
+    solveConst(): void;
     /** 生成部分Token的`name`属性 */
     afterBuild(): void;
     /**
@@ -46,8 +178,9 @@ declare class Token extends AstElement {
     #private;
 }
 declare namespace Token {
-    export { TokenAttribute };
+    export { acceptable, TokenAttribute };
 }
 import AstElement = require("../lib/element");
 import AstText = require("../lib/text");
+type acceptable = import('../../typings/token').acceptable;
 type TokenAttribute<T> = import('../../typings/node').TokenAttribute<T>;

package/dist/src/link/category.d.ts

@@ -4,5 +4,13 @@ export = CategoryToken;
  * @classdesc `{childNodes: [AtomToken, ?Token]}`
  */
 declare class CategoryToken extends LinkToken {
+    set sortkey(arg: string);
+    /** 分类排序关键字 */
+    get sortkey(): string;
+    /**
+     * 设置排序关键字
+     * @param {string} text 排序关键字
+     */
+    setSortkey(text: string): void;
 }
 import LinkToken = require(".");

package/dist/src/link/file.d.ts

@@ -4,6 +4,20 @@ export = FileToken;
  * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken]}`
  */
 declare class FileToken extends LinkToken {
+    set link(arg: string | import("../../lib/title"));
+    /** 图片链接 */
+    get link(): string | import("../../lib/title");
+    /** 图片大小 */
+    get size(): {
+        width: string;
+        height: string;
+    };
+    set width(arg: string);
+    /** 图片宽度 */
+    get width(): string;
+    set height(arg: string);
+    /** 图片高度 */
+    get height(): string;
     /**
      * 获取所有图片参数节点
      * @returns {ImageParameterToken[]}
@@ -21,6 +35,50 @@ declare class FileToken extends LinkToken {
     getHorizAlignArgs(): ImageParameterToken[];
     /** 获取图片垂直对齐参数节点 */
     getVertAlignArgs(): ImageParameterToken[];
+    /**
+     * 获取生效的指定图片参数
+     * @param {string} key 参数名
+     * @complexity `n`
+     */
+    getArg(key: string): ImageParameterToken;
+    /**
+     * 是否具有指定图片参数
+     * @param {string} key 参数名
+     * @complexity `n`
+     */
+    hasArg(key: string): boolean;
+    /**
+     * 移除指定图片参数
+     * @param {string} key 参数名
+     * @complexity `n`
+     */
+    removeArg(key: string): void;
+    /**
+     * 获取图片参数名
+     * @complexity `n`
+     */
+    getKeys(): string[];
+    /**
+     * 获取指定的图片参数值
+     * @param {string} key 参数名
+     * @complexity `n`
+     */
+    getValues(key: string): (string | true)[];
+    /**
+     * 获取生效的指定图片参数值
+     * @param {string} key 参数名
+     * @complexity `n`
+     */
+    getValue(key: string): string | true;
+    /**
+     * 设置图片参数
+     * @param {string} key 参数名
+     * @param {string|boolean} value 参数值
+     * @complexity `n`
+     * @throws `RangeError` 未定义的图片参数
+     * @throws `SyntaxError` 非法的参数
+     */
+    setValue(key: string, value: string | boolean): void;
     #private;
 }
 import LinkToken = require(".");

package/dist/src/link/index.d.ts

@@ -11,19 +11,78 @@ declare class LinkToken extends Token {
      * @param {string} delimiter `|`
      */
     constructor(link: string, linkText: string | undefined, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum, delimiter?: string);
+    set link(arg: import("../../lib/title"));
+    /** 完整链接，和FileToken保持一致 */
+    get link(): import("../../lib/title");
+    set selfLink(arg: boolean);
+    /** 是否链接到自身 */
+    get selfLink(): boolean;
+    set fragment(arg: string);
+    /** fragment */
+    get fragment(): string;
+    set interwiki(arg: string);
+    /** interwiki */
+    get interwiki(): string;
+    /** 链接显示文字 */
+    get innerText(): string;
     /**
      * @override
      * @template {string} T
      * @param {T} key 属性键
      * @param {import('../../../typings/node').TokenAttribute<T>} value 属性值
      */
-    override setAttribute<T extends string>(key: T, value: import("../../../typings/node").TokenAttribute<T>): LinkToken;
+    override setAttribute<T extends string>(key: T, value: import("../../../typings/node").TokenAttribute<T>): this | LinkToken;
     /**
      * @override
+     * @param {string} selector
      */
-    override toString(selector: any): string;
+    override toString(selector: string): string;
     /** @override */
     override text(): string;
+    /** @override */
+    override print(): string;
+    /**
+     * @override
+     * @this {LinkToken & {constructor: typeof LinkToken}}
+     */
+    override cloneNode(this: LinkToken & {
+        constructor: typeof LinkToken;
+    }): LinkToken;
+    /**
+     * 设置链接目标
+     * @param {string} link 链接目标
+     * @throws `SyntaxError` 非法的链接目标
+     */
+    setTarget(link: string): void;
+    /**
+     * 设置跨语言链接
+     * @param {string} lang 语言前缀
+     * @param {string} link 页面标题
+     * @throws `SyntaxError` 非法的跨语言链接
+     */
+    setLangLink(lang: string, link: string): void;
+    /**
+     * 设置fragment
+     * @param {string} fragment fragment
+     */
+    setFragment(fragment: string): void;
+    /**
+     * 修改为到自身的链接
+     * @param {string} fragment fragment
+     * @throws `RangeError` 空fragment
+     */
+    asSelfLink(fragment?: string): void;
+    /**
+     * 设置链接显示文字
+     * @param {string} linkText 链接显示文字
+     * @throws `SyntaxError` 非法的链接显示文字
+     */
+    setLinkText(linkText?: string): void;
+    /**
+     * 自动生成管道符后的链接文字
+     * @throws `Error` 带有"#"或"%"时不可用
+     */
+    pipeTrick(): void;
     #private;
 }
 import Token = require("..");

package/dist/src/magicLink.d.ts

@@ -10,5 +10,27 @@ declare class MagicLinkToken extends Token {
      * @param {import('../../typings/token').accum} accum
      */
     constructor(url: string, doubleSlash: boolean, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    set protocol(arg: string);
+    /** 协议 */
+    get protocol(): string;
+    set link(arg: string);
+    /** 和内链保持一致 */
+    get link(): string;
+    /** @override */
+    override cloneNode(): MagicLinkToken;
+    /**
+     * 获取网址
+     * @throws `Error` 非标准协议
+     */
+    getUrl(): URL;
+    /**
+     * 设置外链目标
+     * @param {string|URL} url 含协议的网址
+     * @throws `SyntaxError` 非法的自由外链目标
+     */
+    setTarget(url: string | URL): void;
+    /** 是否是模板或魔术字参数 */
+    isParamValue(): boolean;
+    #private;
 }
 import Token = require(".");

package/dist/src/nested/index.d.ts

@@ -11,10 +11,8 @@ declare class NestedToken extends Token {
      * @param {import('../../../typings/token').accum} accum
      */
     constructor(wikitext: string | undefined, regex: RegExp, tags: string[], config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
-    /**
-     * @override
-     * @param {number} start 起始位置
-     */
-    override lint(start?: number): any;
+    /** @override */
+    override cloneNode(): any;
+    #private;
 }
 import Token = require("..");

package/dist/src/nowiki/comment.d.ts

@@ -11,9 +11,21 @@ declare class CommentToken extends NowikiToken {
      */
     constructor(wikitext: string, closed?: boolean, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
     closed: boolean;
+    /** 内部wikitext */
+    get innerText(): string;
+    /** @override */
+    override print(): string;
     /**
      * @override
+     * @param {number} start 起始位置
      */
-    override toString(selector: any): string;
+    override lint(start?: number): any;
+    /**
+     * @override
+     * @param {string} selector
+     */
+    override toString(selector: string): string;
+    /** @override */
+    override cloneNode(): CommentToken;
 }
 import NowikiToken = require(".");

package/dist/src/nowiki/dd.d.ts

@@ -4,5 +4,14 @@ export = DdToken;
  * @classdesc `{childNodes: [AstText]}`
  */
 declare class DdToken extends NowikiToken {
+    /** 是否包含<dt> */
+    get dt(): boolean;
+    /** 是否包含<ul> */
+    get ul(): boolean;
+    /** 是否包含<ol> */
+    get ol(): boolean;
+    set indent(arg: number);
+    /** 缩进数 */
+    get indent(): number;
 }
 import NowikiToken = require(".");

package/dist/src/nowiki/doubleUnderscore.d.ts

@@ -4,9 +4,19 @@ export = DoubleUnderscoreToken;
  * @classdesc `{childNodes: [AstText]}`
  */
 declare class DoubleUnderscoreToken extends NowikiToken {
+    /** @override */
+    override print(): string;
     /**
      * @override
+     * @param {string} selector
      */
-    override toString(selector: any): string;
+    override toString(selector: string): string;
+    /** @override */
+    override cloneNode(): DoubleUnderscoreToken;
+    /**
+     * @override
+     * @throws `Error` 禁止修改
+     */
+    override setText(): void;
 }
 import NowikiToken = require(".");

package/dist/src/nowiki/index.d.ts

@@ -11,8 +11,17 @@ declare class NowikiToken extends Token {
     constructor(wikitext: string, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
     /**
      * @override
-     * @param {number} start 起始位置
+     * @this {NowikiToken & {firstChild: AstText, constructor: typeof NowikiToken}}
      */
-    override lint(start?: number): any;
+    override cloneNode(this: NowikiToken & {
+        firstChild: AstText;
+        constructor: typeof NowikiToken;
+    }): NowikiToken;
+    /**
+     * @override
+     * @param {string} str 新文本
+     */
+    override setText(str: string): string;
 }
 import Token = require("..");
+import AstText = require("../../lib/text");

package/dist/src/nowiki/quote.d.ts

@@ -9,12 +9,5 @@ declare class QuoteToken extends NowikiToken {
      * @param {import('../../../typings/token').accum} accum
      */
     constructor(n: number, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
-    /**
-     * @override
-     * @this {AstText}
-     * @param {number} start 起始位置
-     */
-    override lint(this: AstText, start?: number): import("../../../typings/token").LintError[];
 }
 import NowikiToken = require(".");
-import AstText = require("../../lib/text");

package/dist/src/onlyinclude.d.ts

@@ -9,9 +9,16 @@ declare class OnlyincludeToken extends Token {
      * @param {import('../../typings/token').accum} accum
      */
     constructor(inner: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
+    /** 内部wikitext */
+    get innerText(): string;
     /**
      * @override
+     * @param {string} selector
      */
-    override toString(selector: any): string;
+    override toString(selector: string): string;
+    /** @override */
+    override print(): string;
+    /** @override */
+    override cloneNode(): OnlyincludeToken;
 }
 import Token = require(".");

package/dist/src/paramTag/index.d.ts

@@ -11,14 +11,19 @@ declare class ParamTagToken extends Token {
     constructor(wikitext: string, config?: import("../../../typings/token").ParserConfig, accum?: import('../../../typings/token').accum);
     /**
      * @override
+     * @param {string} selector
      */
-    override toString(selector: any): string;
+    override toString(selector: string): string;
     /** @override */
     override text(): string;
+    /** @override */
+    override print(): string;
     /**
      * @override
-     * @param {number} start 起始位置
+     * @this {ParamTagToken & {constructor: typeof ParamTagToken}}
      */
-    override lint(start?: number): any;
+    override cloneNode(this: ParamTagToken & {
+        constructor: typeof ParamTagToken;
+    }): ParamTagToken;
 }
 import Token = require("..");

package/dist/src/parameter.d.ts

@@ -12,11 +12,20 @@ declare class ParameterToken extends Token {
     constructor(key: string | number, value: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum);
     /** 是否是匿名参数 */
     get anon(): boolean;
+    set value(arg: string);
+    /** getValue()的getter */
+    get value(): string;
+    /**
+     * 是否是重复参数
+     * @this {ParameterToken & {parentNode: TranscludeToken}}
+     */
+    get duplicated(): boolean;
     /**
      * @override
+     * @param {string} selector
      * @returns {string}
      */
-    override toString(selector: any): string;
+    override toString(selector: string): string;
     /**
      * @override
      * @returns {string}
@@ -24,5 +33,43 @@ declare class ParameterToken extends Token {
     override text(): string;
     /** @override */
     override getGaps(): 1 | 0;
+    /** @override */
+    override print(): string;
+    /**
+     * 获取参数值
+     * @this {ParameterToken & {parentNode: TranscludeToken}}
+     */
+    getValue(this: ParameterToken & {
+        parentNode: import("./transclude");
+    }): string;
+    /** @override */
+    override cloneNode(): ParameterToken;
+    /**
+     * @override
+     * @param {ParameterToken} token 待替换的节点
+     * @complexity `n`
+     */
+    override safeReplaceWith(token: ParameterToken): void;
+    /**
+     * 设置参数值
+     * @this {ParameterToken & {parentNode: TranscludeToken}}
+     * @param {string} value 参数值
+     * @throws `SyntaxError` 非法的模板参数
+     */
+    setValue(this: ParameterToken & {
+        parentNode: import("./transclude");
+    }, value: string): void;
+    /**
+     * 修改参数名
+     * @this {ParameterToken & {parentNode: TranscludeToken}}
+     * @param {string} key 新参数名
+     * @param {boolean} force 是否无视冲突命名
+     * @throws `Error` 仅用于模板参数
+     * @throws `SyntaxError` 非法的模板参数名
+     * @throws `RangeError` 更名造成重复参数
+     */
+    rename(this: ParameterToken & {
+        parentNode: import("./transclude");
+    }, key: string, force: boolean): void;
 }
 import Token = require(".");

package/dist/src/syntax.d.ts

@@ -9,7 +9,12 @@ declare class SyntaxToken extends Token {
      * @param {RegExp} pattern 语法正则
      * @param {string} type Token.type
      * @param {import('../../typings/token').accum} accum
+     * @param {import('../../typings/token').acceptable} acceptable 可接受的子节点设置
+     * @throws `RangeError` 含有g修饰符的语法正则
      */
-    constructor(wikitext: string, pattern: RegExp, type?: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum, acceptable?: any);
+    constructor(wikitext: string, pattern: RegExp, type?: string, config?: import("../../typings/token").ParserConfig, accum?: import('../../typings/token').accum, acceptable?: import('../../typings/token').acceptable);
+    /** @override */
+    override cloneNode(): SyntaxToken;
+    #private;
 }
 import Token = require(".");