wikiparser-node 1.4.3-b → 1.4.4

package/dist/src/index.d.ts

@@ -0,0 +1,143 @@
+import { BuildMethod } from '../util/constants';
+import { AstRange } from '../lib/range';
+import Parser from '../index';
+import { AstElement } from '../lib/element';
+import { AstText } from '../lib/text';
+import type { LintError } from '../base';
+import type { Range } from '../lib/ranges';
+import type { Title } from '../lib/title';
+import type { AstNodes, IncludeToken, HtmlToken, ExtToken, TranscludeToken, CommentToken, FileToken, LinkToken, ExtLinkToken, MagicLinkToken, ImageParameterToken, ImagemapLinkToken } from '../internal';
+import type { CaretPosition } from '../lib/node';
+import type { TokenTypes } from '../util/constants';
+declare type TagToken = IncludeToken | ExtToken | HtmlToken;
+/**
+ * 所有节点的基类
+ * @classdesc `{childNodes: ...(AstText|Token)}`
+ */
+export declare class Token extends AstElement {
+    #private;
+    type: TokenTypes;
+    /** 所有图片，包括图库 */
+    get images(): FileToken[];
+    /** 所有内链、外链和自由外链 */
+    get links(): (LinkToken | ExtLinkToken | MagicLinkToken | ImageParameterToken | ImagemapLinkToken)[];
+    /** 所有模板和模块 */
+    get embeds(): TranscludeToken[];
+    /** @class */
+    constructor(wikitext?: string, config?: Parser.Config, accum?: Token[], acceptable?: Acceptable);
+    /**
+     * @override
+     * @param child 待插入的子节点
+     * @param i 插入位置
+     */
+    insertAt(child: string, i?: number): AstText;
+    insertAt<T extends AstNodes>(child: T, i?: number): T;
+    /**
+     * 规范化页面标题
+     * @param title 标题（含或不含命名空间前缀）
+     * @param defaultNs 命名空间
+     * @param halfParsed 仅供内部使用
+     * @param decode 是否需要解码
+     * @param selfLink 是否允许selfLink
+     */
+    normalizeTitle(title: string, defaultNs?: number, halfParsed?: boolean, decode?: boolean, selfLink?: boolean): Title;
+    /** @override */
+    lint(start?: number): LintError[];
+    /**
+     * @override
+     * @param i 移除位置
+     */
+    removeAt(i: number): AstNodes;
+    /**
+     * 替换为同类节点
+     * @param token 待替换的节点
+     * @throws `Error` 不存在父节点
+     */
+    safeReplaceWith(token: this): void;
+    /**
+     * 创建HTML注释
+     * @param data 注释内容
+     */
+    createComment(data?: string): CommentToken;
+    /**
+     * 创建标签
+     * @param tagName 标签名
+     * @param options 选项
+     * @param options.selfClosing 是否自封闭
+     * @param options.closing 是否是闭合标签
+     * @throws `RangeError` 非法的标签名
+     */
+    createElement(tagName: string, { selfClosing, closing }?: {
+        selfClosing?: boolean;
+        closing?: boolean;
+    }): TagToken;
+    /**
+     * 创建纯文本节点
+     * @param data 文本内容
+     */
+    createTextNode(data?: string): AstText;
+    /** 创建AstRange对象 */
+    createRange(): AstRange;
+    /**
+     * 找到给定位置
+     * @param index 位置
+     */
+    caretPositionFromIndex(index?: number): CaretPosition | undefined;
+    /**
+     * 找到给定位置
+     * @param x 列数
+     * @param y 行数
+     */
+    caretPositionFromPoint(x: number, y: number): CaretPosition | undefined;
+    /**
+     * 找到给定位置所在的最外层节点
+     * @param index 位置
+     */
+    elementFromIndex(index?: number): AstNodes | undefined;
+    /**
+     * 找到给定位置所在的最外层节点
+     * @param x 列数
+     * @param y 行数
+     */
+    elementFromPoint(x: number, y: number): AstNodes | undefined;
+    /**
+     * 找到给定位置所在的所有节点
+     * @param index 位置
+     */
+    elementsFromIndex(index?: number): AstNodes[];
+    /**
+     * 找到给定位置所在的所有节点
+     * @param x 列数
+     * @param y 行数
+     */
+    elementsFromPoint(x: number, y: number): AstNodes[];
+    /**
+     * 判断标题是否是跨维基链接
+     * @param title 标题
+     */
+    isInterwiki(title: string): RegExpExecArray | null;
+    /** 深拷贝节点 */
+    cloneNode(): this;
+    /** 获取全部章节 */
+    sections(): (AstText | Token)[][] | undefined;
+    /**
+     * 获取指定章节
+     * @param n 章节序号
+     */
+    section(n: number): (AstText | Token)[] | undefined;
+    /**
+     * 获取指定的外层HTML标签
+     * @param tag HTML标签名
+     * @throws `RangeError` 非法的标签或空标签
+     */
+    findEnclosingHtml(tag?: string): AstRange | undefined;
+    /** 获取全部分类 */
+    getCategories(): [string, string | undefined][];
+    /** 重新解析单引号 */
+    redoQuotes(): void;
+    /** 解析部分魔术字 */
+    solveConst(): void;
+    /** 合并普通节点的普通子节点 */
+    flatten(): void;
+}
+export {};