wikiparser-node 0.11.0 → 1.0.0-beta.1

package/dist/lib/element.d.ts

@@ -1,162 +1,176 @@
-export = AstElement;
+import * as Parser from '../index';
+import * as AstNode from './node';
+import AstText = require('./text');
+import type { AstNodeTypes } from './node';
 /** 类似HTMLElement */
-declare class AstElement extends AstNode {
-    /** @type {string} */ name: string;
-    /** 子节点总数 */
+declare abstract class AstElement extends AstNode {
+    #private;
+    /** @browser */
+    name?: string;
+    /**
+     * 子节点总数
+     * @browser
+     */
     get length(): number;
+    /** 全部非文本子节点 */
+    get children(): import('../src')[];
+    /** 首位非文本子节点 */
+    get firstElementChild(): import('../src') | undefined;
+    /** 末位非文本子节点 */
+    get lastElementChild(): import('../src') | undefined;
+    /** 非文本子节点总数 */
+    get childElementCount(): number;
+    /** 父节点 */
+    get parentElement(): import('../src') | undefined;
+    /** AstElement.prototype.text()的getter写法 */
+    get outerText(): string;
+    /** 不可见 */
+    get hidden(): boolean;
+    /** 后一个可见的兄弟节点 */
+    get nextVisibleSibling(): AstNodeTypes | undefined;
+    /** 前一个可见的兄弟节点 */
+    get previousVisibleSibling(): AstNodeTypes | undefined;
+    /** 内部高度 */
+    get clientHeight(): number | undefined;
+    /** 内部宽度 */
+    get clientWidth(): number | undefined;
+    constructor();
     /**
-     * 全部非文本子节点
-     * @complexity `n`
+     * 可见部分
+     * @browser
+     * @param separator 子节点间的连接符
      */
-    get children(): AstElement[];
+    text(separator?: string): string;
     /**
-     * 首位非文本子节点
-     * @returns {this}
+     * 合并相邻的文本子节点
+     * @browser
      */
-    get firstElementChild(): AstElement;
+    normalize(): void;
     /**
-     * 末位非文本子节点
-     * @complexity `n`
+     * 移除子节点
+     * @browser
+     * @param i 移除位置
      */
-    get lastElementChild(): AstElement;
+    removeAt(i: number): AstNodeTypes;
     /**
-     * 非文本子节点总数
-     * @complexity `n`
+     * 插入子节点
+     * @browser
+     * @param node 待插入的子节点
+     * @param i 插入位置
+     * @throws `RangeError` 不能插入祖先节点
      */
-    get childElementCount(): number;
-    /** 父节点 */
-    get parentElement(): this;
+    insertAt<T extends AstNodeTypes>(node: T, i?: number): T;
     /**
-     * AstElement.prototype.text()的getter写法
-     * @complexity `n`
+     * 最近的祖先节点
+     * @browser
      */
-    get outerText(): string;
+    closest(selector: string): import('../src') | undefined;
     /**
-     * 不可见
+     * 在末尾批量插入子节点
+     * @browser
+     * @param elements 插入节点
      */
-    get hidden(): boolean;
+    append(...elements: (AstNodeTypes | string)[]): void;
     /**
-     * 后一个可见的兄弟节点
-     * @complexity `n`
+     * 批量替换子节点
+     * @browser
+     * @param elements 新的子节点
      */
-    get nextVisibleSibling(): this;
+    replaceChildren(...elements: (AstNodeTypes | string)[]): void;
     /**
-     * 前一个可见的兄弟节点
-     * @complexity `n`
+     * 修改文本子节点
+     * @browser
+     * @param str 新文本
+     * @param i 子节点位置
+     * @throws `RangeError` 对应位置的子节点不是文本节点
      */
-    get previousVisibleSibling(): this;
-    /** 内部高度 */
-    get clientHeight(): number;
-    /** 内部宽度 */
-    get clientWidth(): number;
+    setText(str: string, i?: number): string;
     /**
-     * 销毁
-     * @complexity `n`
+     * 还原为wikitext
+     * @browser
+     * @param separator 子节点间的连接符
      */
-    destroy(): void;
+    toString(selector?: string, separator?: string): string;
     /**
-     * 检查是否符合选择器
-     * @param {string|SelectorArray[]} selector
-     * @returns {boolean}
-     * @complexity `n`
+     * Linter
+     * @browser
      */
-    matches(selector: string | SelectorArray[]): boolean;
+    lint(start?: number): Parser.LintError[];
     /**
-     * 符合选择器的第一个后代节点
-     * @param {string} selector
-     * @returns {this|undefined}
-     * @complexity `n`
+     * 以HTML格式打印
+     * @browser
+     * @param opt 选项
      */
-    querySelector(selector: string): this | undefined;
+    print(opt?: PrintOpt): string;
     /**
-     * 符合选择器的所有后代节点
-     * @param {string} selector
-     * @complexity `n`
+     * 保存为JSON
+     * @browser
+     * @param file 文件名
      */
-    querySelectorAll(selector: string): AstElement[];
+    json(file?: string): unknown;
+    /** 销毁 */
+    destroy(): void;
+    /** 检查是否符合选择器 */
+    matches(selector?: string): boolean;
+    /** 符合选择器的第一个后代节点 */
+    querySelector(selector: string): import('../src') | undefined;
+    /** 符合选择器的所有后代节点 */
+    querySelectorAll(selector: string): import('../src')[];
     /**
      * id选择器
-     * @param {string} id id名
+     * @param id id名
      */
-    getElementById(id: string): AstElement;
+    getElementById(id: string): import('../src') | undefined;
     /**
      * 类选择器
-     * @param {string} className 类名之一
+     * @param className 类名之一
      */
-    getElementsByClassName(className: string): AstElement[];
+    getElementsByClassName(className: string): import('../src')[];
     /**
      * 标签名选择器
-     * @param {string} name 标签名
+     * @param name 标签名
      */
-    getElementsByTagName(name: string): AstElement[];
+    getElementsByTagName(name: string): import('../src')[];
     /**
      * 获取某一行的wikitext
-     * @param {number} n 行号
+     * @param n 行号
      */
-    getLine(n: number): string;
+    getLine(n: number): string | undefined;
     /**
      * 在开头批量插入子节点
-     * @param {...this} elements 插入节点
-     * @complexity `n`
-     */
-    prepend(...elements: AstElement[]): void;
-    /**
-     * 最近的祖先节点
-     * @param {string} selector
-     */
-    closest(selector: string): this;
-    /**
-     * 在末尾批量插入子节点
-     * @param {...this} elements 插入节点
-     * @complexity `n`
-     */
-    append(...elements: AstElement[]): void;
-    /**
-     * 批量替换子节点
-     * @param {...this} elements 新的子节点
-     * @complexity `n`
+     * @param elements 插入节点
      */
-    replaceChildren(...elements: AstElement[]): void;
+    prepend(...elements: (AstNodeTypes | string)[]): void;
     /**
-     * 修改文本子节点
-     * @param {string} str 新文本
-     * @param {number} i 子节点位置
-     * @throws `RangeError` 对应位置的子节点不是文本节点
-     */
-    setText(str: string, i?: number): string;
-    /**
-     * 还原为wikitext
-     * @param {string} selector
-     * @param {string} separator 子节点间的连接符
-     * @returns {string}
+     * 移除子节点
+     * @param node 子节点
      */
-    toString(selector: string, separator?: string): string;
+    removeChild<T extends AstNodeTypes>(node: T): T;
     /**
-     * Linter
-     * @param {number} start 起始位置
+     * 在末尾插入子节点
+     * @param node 插入节点
      */
-    lint(start?: number): import("../../typings/token").LintError[];
+    appendChild(node: string): AstText;
+    /** @ignore */
+    appendChild<T extends AstNodeTypes>(node: T): T;
     /**
-     * 以HTML格式打印
-     * @param {import('../../typings/node').printOpt} opt 选项
-     * @returns {string}
+     * 在指定位置前插入子节点
+     * @param child 插入节点
+     * @param reference 指定位置处的子节点
      */
-    print(opt?: import('../../typings/node').printOpt): string;
+    insertBefore(child: string, reference?: AstNodeTypes): AstText;
+    /** @ignore */
+    insertBefore<T extends AstNodeTypes>(child: T, reference?: AstNodeTypes): T;
     /**
-     * 保存为JSON
-     * @param {string} file 文件名
-     * @returns {Record<string, *>}
+     * 替换子节点
+     * @param newChild 新子节点
+     * @param oldChild 原子节点
      */
-    json(file: string): Record<string, any>;
+    replaceChild<T extends AstNodeTypes>(newChild: AstNodeTypes | string, oldChild: T): T;
     /**
      * 输出AST
-     * @param {number} depth 当前深度
+     * @param depth 当前深度
      */
     echo(depth?: number): void;
-    #private;
-}
-declare namespace AstElement {
-    export { SelectorArray };
 }
-import AstNode = require("./node");
-type SelectorArray = import('../../typings/parser').SelectorArray;
+export = AstElement;