wikiparser-node 1.16.3 → 1.16.5

package/dist/lib/node.d.ts

@@ -1,5 +1,9 @@
 import type { LintError, AstNode as AstNodeBase, TokenTypes } from '../base';
 import type { AstText, Token } from '../internal';
+export interface Font {
+    bold: boolean;
+    italic: boolean;
+}
 export type AstNodes = AstText | Token;
 export interface Dimension {
     readonly height: number;
@@ -13,163 +17,228 @@ export interface CaretPosition {
     readonly offsetNode: AstNodes;
     readonly offset: number;
 }
-/** 类似Node */
+/**
+ * Node-like
+ *
+ * 类似Node
+ */
 export declare abstract class AstNode implements AstNodeBase {
     #private;
     data?: string | undefined;
     readonly childNodes: readonly AstNodes[];
     abstract get type(): TokenTypes | 'text';
     abstract set type(value: TokenTypes | "text");
-    /** 可见部分 */
+    /**
+     * Get the visible text
+     *
+     * 可见部分
+     */
     text(): string;
     lint(): LintError[];
     print(): string;
-    /** 首位子节点 */
+    /** first child node / 首位子节点 */
     get firstChild(): AstNodes | undefined;
-    /** 末位子节点 */
+    /** last child node / 末位子节点 */
     get lastChild(): AstNodes | undefined;
-    /** 父节点 */
+    /** parent node / 父节点 */
     get parentNode(): Token | undefined;
-    /** 后一个兄弟节点 */
+    /** next sibling node / 后一个兄弟节点 */
     get nextSibling(): AstNodes | undefined;
-    /** 前一个兄弟节点 */
+    /** previous sibling node / 前一个兄弟节点 */
     get previousSibling(): AstNodes | undefined;
-    /** 行数 */
+    /** number of lines / 行数 */
     get offsetHeight(): number;
-    /** 最后一行的列数 */
+    /** number of columns of the last line / 最后一行的列数 */
     get offsetWidth(): number;
-    /** 后一个非文本兄弟节点 */
+    /** next sibling element / 后一个非文本兄弟节点 */
     get nextElementSibling(): Token | undefined;
-    /** 前一个非文本兄弟节点 */
+    /** previous sibling element / 前一个非文本兄弟节点 */
     get previousElementSibling(): Token | undefined;
-    /** 后一个可见的兄弟节点 */
+    /** next visibling sibling node / 后一个可见的兄弟节点 */
     get nextVisibleSibling(): AstNodes | undefined;
-    /** 前一个可见的兄弟节点 */
+    /** previous visible sibling node / 前一个可见的兄弟节点 */
     get previousVisibleSibling(): AstNodes | undefined;
-    /** 是否具有根节点 */
+    /** whether to be connected to a root token / 是否具有根节点 */
     get isConnected(): boolean;
-    /** 后方是否还有其他节点（不含后代） */
+    /** whether to be the end of a document / 后方是否还有其他节点（不含后代） */
     get eof(): boolean | undefined;
-    /** 相对于父容器的行号 */
+    /** line number relative to its parent / 相对于父容器的行号 */
     get offsetTop(): number;
-    /** 相对于父容器的列号 */
+    /** column number of the last line relative to its parent / 相对于父容器的列号 */
     get offsetLeft(): number;
-    /** 位置、大小和padding */
+    /** position, dimension and paddings / 位置、大小和padding */
     get style(): Position & Dimension & {
         padding: number;
     };
-    /** 字体样式 */
-    get font(): {
-        bold: boolean;
-        italic: boolean;
-    };
-    /** 是否粗体 */
+    /** font weigth and style / 字体样式 */
+    get font(): Font;
+    /** whether to be bold / 是否粗体 */
     get bold(): boolean;
-    /** 是否斜体 */
+    /** whether to be italic / 是否斜体 */
     get italic(): boolean;
     constructor();
-    /** 获取根节点 */
+    /**
+     * Get the root node
+     *
+     * 获取根节点
+     */
     getRootNode(): Token | this;
     /**
+     * Convert the position to the character index
+     *
      * 将行列号转换为字符位置
-     * @param top 行号
-     * @param left 列号
+     * @param top line number / 行号
+     * @param left column number / 列号
      */
     indexFromPos(top: number, left: number): number | undefined;
     /**
+     * Convert the character indenx to the position
+     *
      * 将字符位置转换为行列号
-     * @param index 字符位置
+     * @param index character index / 字符位置
      */
     posFromIndex(index: number): Position | undefined;
     /**
+     * Get the relative character index of the current node, or its `j`-th child node
+     *
      * 获取当前节点的相对字符位置，或其第`j`个子节点的相对字符位置
-     * @param j 子节点序号
+     * @param j rank of the child node / 子节点序号
      */
     getRelativeIndex(j?: number): number;
-    /** 获取当前节点的绝对位置 */
+    /**
+     * Get the absolute character index of the current node
+     *
+     * 获取当前节点的绝对位置
+     */
     getAbsoluteIndex(): number;
-    /** 获取当前节点的行列位置和大小 */
+    /**
+     * Get the position and dimension of the current node
+     *
+     * 获取当前节点的行列位置和大小
+     */
     getBoundingClientRect(): Dimension & Position;
     /**
+     * Whether to be of a certain type
+     *
      * 是否是某种类型的节点
-     * @param type 节点类型
+     * @param type token type / 节点类型
+     */
+    is<T extends Token>(type: TokenTypes): this is T;
+    /**
+     * Get the text and the start/end positions of all lines
+     *
+     * 获取所有行的wikitext和起止位置
      */
-    is<T extends Token>(type: string): this is T;
-    /** 获取所有行的wikitext和起止位置 */
     getLines(): [string, number, number][];
     /**
+     * Check if the node is identical
+     *
      * 是否是全同节点
-     * @param node 待比较的节点
+     * @param node node to be compared to / 待比较的节点
      * @throws `assert.AssertionError`
      */
     isEqualNode(node: AstNode): boolean;
     /**
+     * Insert a batch of sibling nodes after the current node
+     *
      * 在后方批量插入兄弟节点
-     * @param nodes 插入节点
+     * @param nodes nodes to be inserted / 插入节点
      */
     after(...nodes: (AstNodes | string)[]): void;
     /**
+     * Insert a batch of sibling nodes before the current node
+     *
      * 在前方批量插入兄弟节点
-     * @param nodes 插入节点
+     * @param nodes nodes to be inserted / 插入节点
      */
     before(...nodes: (AstNodes | string)[]): void;
-    /** 移除当前节点 */
+    /**
+     * Remove the current node
+     *
+     * 移除当前节点
+     */
     remove(): void;
     /**
+     * Replace the current node with new nodes
+     *
      * 将当前节点批量替换为新的节点
-     * @param nodes 插入节点
+     * @param nodes nodes to be inserted / 插入节点
      */
     replaceWith(...nodes: (AstNodes | string)[]): void;
     /**
+     * Check if the node is a descendant
+     *
      * 是自身或后代节点
-     * @param node 待检测节点
+     * @param node node to be compared to / 待检测节点
      */
     contains(node: AstNode): boolean;
     /**
+     * Add an event listener
+     *
      * 添加事件监听
-     * @param types 事件类型
-     * @param listener 监听函数
+     * @param types event type / 事件类型
+     * @param listener listener function / 监听函数
      * @param options 选项
-     * @param options.once 仅执行一次
+     * @param options.once to be executed only once / 仅执行一次
      */
     addEventListener(types: string | string[], listener: (...args: any[]) => void, options?: {
         once?: boolean;
     }): void;
     /**
+     * Remove an event listener
+     *
      * 移除事件监听
-     * @param types 事件类型
-     * @param listener 监听函数
+     * @param types event type / 事件类型
+     * @param listener listener function / 监听函数
      */
     removeEventListener(types: string | string[], listener: (...args: any[]) => void): void;
     /**
+     * Remove all event listeners
+     *
      * 移除事件的所有监听
-     * @param types 事件类型
+     * @param types event type / 事件类型
      */
     removeAllEventListeners(types: string | string[]): void;
     /**
+     * List all event listeners
+     *
      * 列举事件监听
-     * @param type 事件类型
+     * @param type event type / 事件类型
      */
     listEventListeners(type: string): Function[];
     /**
+     * Dispatch an event
+     *
      * 触发事件
-     * @param e 事件对象
-     * @param data 事件数据
+     * @param e event object / 事件对象
+     * @param data event data / 事件数据
      */
     dispatchEvent(e: Event, data: unknown): void;
-    /** 获取所有祖先节点 */
+    /**
+     * Get all the ancestor nodes
+     *
+     * 获取所有祖先节点
+     */
     getAncestors(): Token[];
     /**
+     * Compare the relative position with another node
+     *
      * 比较和另一个节点的相对位置
-     * @param other 待比较的节点
+     * @param other node to be compared with / 待比较的节点
      * @throws `RangeError` 不在同一个语法树
      */
     compareDocumentPosition(other: AstNodes): number;
-    /** 销毁 */
+    /**
+     * Destroy the instance
+     *
+     * 销毁
+     */
     destroy(): void;
     /**
+     * Get the wikitext of a line
+     *
      * 获取某一行的wikitext
-     * @param n 行号
+     * @param n line number / 行号
      */
     getLine(n: number): string | undefined;
 }