@ckeditor/ckeditor5-engine 39.0.1 → 40.0.0

package/src/model/element.d.ts

@@ -1,165 +1,165 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module engine/model/element
- */
-import Node, { type NodeAttributes } from './node';
-import type Item from './item';
-/**
- * Model element. Type of {@link module:engine/model/node~Node node} that has a {@link module:engine/model/element~Element#name name} and
- * {@link module:engine/model/element~Element#getChildren child nodes}.
- *
- * **Important**: see {@link module:engine/model/node~Node} to read about restrictions using `Element` and `Node` API.
- */
-export default class Element extends Node {
-    /**
-     * Element name.
-     */
-    readonly name: string;
-    /**
-     * List of children nodes.
-     */
-    private readonly _children;
-    /**
-     * Creates a model element.
-     *
-     * **Note:** Constructor of this class shouldn't be used directly in the code.
-     * Use the {@link module:engine/model/writer~Writer#createElement} method instead.
-     *
-     * @internal
-     * @param name Element's name.
-     * @param attrs Element's attributes. See {@link module:utils/tomap~toMap} for a list of accepted values.
-     * @param children One or more nodes to be inserted as children of created element.
-     */
-    constructor(name: string, attrs?: NodeAttributes, children?: string | Item | Iterable<string | Item>);
-    /**
-     * Number of this element's children.
-     */
-    get childCount(): number;
-    /**
-     * Sum of {@link module:engine/model/node~Node#offsetSize offset sizes} of all of this element's children.
-     */
-    get maxOffset(): number;
-    /**
-     * Is `true` if there are no nodes inside this element, `false` otherwise.
-     */
-    get isEmpty(): boolean;
-    /**
-     * Gets the child at the given index.
-     */
-    getChild(index: number): Node | null;
-    /**
-     * Returns an iterator that iterates over all of this element's children.
-     */
-    getChildren(): IterableIterator<Node>;
-    /**
-     * Returns an index of the given child node. Returns `null` if given node is not a child of this element.
-     *
-     * @param node Child node to look for.
-     * @returns Child node's index in this element.
-     */
-    getChildIndex(node: Node): number | null;
-    /**
-     * Returns the starting offset of given child. Starting offset is equal to the sum of
-     * {@link module:engine/model/node~Node#offsetSize offset sizes} of all node's siblings that are before it. Returns `null` if
-     * given node is not a child of this element.
-     *
-     * @param node Child node to look for.
-     * @returns Child node's starting offset.
-     */
-    getChildStartOffset(node: Node): number | null;
-    /**
-     * Returns index of a node that occupies given offset. If given offset is too low, returns `0`. If given offset is
-     * too high, returns {@link module:engine/model/element~Element#getChildIndex index after last child}.
-     *
-     * ```ts
-     * const textNode = new Text( 'foo' );
-     * const pElement = new Element( 'p' );
-     * const divElement = new Element( [ textNode, pElement ] );
-     * divElement.offsetToIndex( -1 ); // Returns 0, because offset is too low.
-     * divElement.offsetToIndex( 0 ); // Returns 0, because offset 0 is taken by `textNode` which is at index 0.
-     * divElement.offsetToIndex( 1 ); // Returns 0, because `textNode` has `offsetSize` equal to 3, so it occupies offset 1 too.
-     * divElement.offsetToIndex( 2 ); // Returns 0.
-     * divElement.offsetToIndex( 3 ); // Returns 1.
-     * divElement.offsetToIndex( 4 ); // Returns 2. There are no nodes at offset 4, so last available index is returned.
-     * ```
-     */
-    offsetToIndex(offset: number): number;
-    /**
-     * Returns a descendant node by its path relative to this element.
-     *
-     * ```ts
-     * // <this>a<b>c</b></this>
-     * this.getNodeByPath( [ 0 ] );     // -> "a"
-     * this.getNodeByPath( [ 1 ] );     // -> <b>
-     * this.getNodeByPath( [ 1, 0 ] );  // -> "c"
-     * ```
-     *
-     * @param relativePath Path of the node to find, relative to this element.
-     */
-    getNodeByPath(relativePath: Array<number>): Node;
-    /**
-     * Returns the parent element of the given name. Returns null if the element is not inside the desired parent.
-     *
-     * @param parentName The name of the parent element to find.
-     * @param options Options object.
-     * @param options.includeSelf When set to `true` this node will be also included while searching.
-     */
-    findAncestor(parentName: string, options?: {
-        includeSelf?: boolean;
-    }): Element | null;
-    /**
-     * Converts `Element` instance to plain object and returns it. Takes care of converting all of this element's children.
-     *
-     * @returns `Element` instance converted to plain object.
-     */
-    toJSON(): unknown;
-    /**
-     * Creates a copy of this element and returns it. Created element has the same name and attributes as the original element.
-     * If clone is deep, the original element's children are also cloned. If not, then empty element is returned.
-     *
-     * @internal
-     * @param deep If set to `true` clones element and all its children recursively. When set to `false`,
-     * element will be cloned without any child.
-     */
-    _clone(deep?: boolean): Element;
-    /**
-     * {@link module:engine/model/element~Element#_insertChild Inserts} one or more nodes at the end of this element.
-     *
-     * @see module:engine/model/writer~Writer#append
-     * @internal
-     * @param nodes Nodes to be inserted.
-     */
-    _appendChild(nodes: string | Item | Iterable<string | Item>): void;
-    /**
-     * Inserts one or more nodes at the given index and sets {@link module:engine/model/node~Node#parent parent} of these nodes
-     * to this element.
-     *
-     * @see module:engine/model/writer~Writer#insert
-     * @internal
-     * @param index Index at which nodes should be inserted.
-     * @param items Items to be inserted.
-     */
-    _insertChild(index: number, items: string | Item | Iterable<string | Item>): void;
-    /**
-     * Removes one or more nodes starting at the given index and sets
-     * {@link module:engine/model/node~Node#parent parent} of these nodes to `null`.
-     *
-     * @see module:engine/model/writer~Writer#remove
-     * @internal
-     * @param index Index of the first node to remove.
-     * @param howMany Number of nodes to remove.
-     * @returns Array containing removed nodes.
-     */
-    _removeChildren(index: number, howMany?: number): Array<Node>;
-    /**
-     * Creates an `Element` instance from given plain object (i.e. parsed JSON string).
-     * Converts `Element` children to proper nodes.
-     *
-     * @param json Plain object to be converted to `Element`.
-     * @returns `Element` instance created using given plain object.
-     */
-    static fromJSON(json: any): Element;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/model/element
+ */
+import Node, { type NodeAttributes } from './node';
+import type Item from './item';
+/**
+ * Model element. Type of {@link module:engine/model/node~Node node} that has a {@link module:engine/model/element~Element#name name} and
+ * {@link module:engine/model/element~Element#getChildren child nodes}.
+ *
+ * **Important**: see {@link module:engine/model/node~Node} to read about restrictions using `Element` and `Node` API.
+ */
+export default class Element extends Node {
+    /**
+     * Element name.
+     */
+    readonly name: string;
+    /**
+     * List of children nodes.
+     */
+    private readonly _children;
+    /**
+     * Creates a model element.
+     *
+     * **Note:** Constructor of this class shouldn't be used directly in the code.
+     * Use the {@link module:engine/model/writer~Writer#createElement} method instead.
+     *
+     * @internal
+     * @param name Element's name.
+     * @param attrs Element's attributes. See {@link module:utils/tomap~toMap} for a list of accepted values.
+     * @param children One or more nodes to be inserted as children of created element.
+     */
+    constructor(name: string, attrs?: NodeAttributes, children?: string | Item | Iterable<string | Item>);
+    /**
+     * Number of this element's children.
+     */
+    get childCount(): number;
+    /**
+     * Sum of {@link module:engine/model/node~Node#offsetSize offset sizes} of all of this element's children.
+     */
+    get maxOffset(): number;
+    /**
+     * Is `true` if there are no nodes inside this element, `false` otherwise.
+     */
+    get isEmpty(): boolean;
+    /**
+     * Gets the child at the given index.
+     */
+    getChild(index: number): Node | null;
+    /**
+     * Returns an iterator that iterates over all of this element's children.
+     */
+    getChildren(): IterableIterator<Node>;
+    /**
+     * Returns an index of the given child node. Returns `null` if given node is not a child of this element.
+     *
+     * @param node Child node to look for.
+     * @returns Child node's index in this element.
+     */
+    getChildIndex(node: Node): number | null;
+    /**
+     * Returns the starting offset of given child. Starting offset is equal to the sum of
+     * {@link module:engine/model/node~Node#offsetSize offset sizes} of all node's siblings that are before it. Returns `null` if
+     * given node is not a child of this element.
+     *
+     * @param node Child node to look for.
+     * @returns Child node's starting offset.
+     */
+    getChildStartOffset(node: Node): number | null;
+    /**
+     * Returns index of a node that occupies given offset. If given offset is too low, returns `0`. If given offset is
+     * too high, returns {@link module:engine/model/element~Element#getChildIndex index after last child}.
+     *
+     * ```ts
+     * const textNode = new Text( 'foo' );
+     * const pElement = new Element( 'p' );
+     * const divElement = new Element( [ textNode, pElement ] );
+     * divElement.offsetToIndex( -1 ); // Returns 0, because offset is too low.
+     * divElement.offsetToIndex( 0 ); // Returns 0, because offset 0 is taken by `textNode` which is at index 0.
+     * divElement.offsetToIndex( 1 ); // Returns 0, because `textNode` has `offsetSize` equal to 3, so it occupies offset 1 too.
+     * divElement.offsetToIndex( 2 ); // Returns 0.
+     * divElement.offsetToIndex( 3 ); // Returns 1.
+     * divElement.offsetToIndex( 4 ); // Returns 2. There are no nodes at offset 4, so last available index is returned.
+     * ```
+     */
+    offsetToIndex(offset: number): number;
+    /**
+     * Returns a descendant node by its path relative to this element.
+     *
+     * ```ts
+     * // <this>a<b>c</b></this>
+     * this.getNodeByPath( [ 0 ] );     // -> "a"
+     * this.getNodeByPath( [ 1 ] );     // -> <b>
+     * this.getNodeByPath( [ 1, 0 ] );  // -> "c"
+     * ```
+     *
+     * @param relativePath Path of the node to find, relative to this element.
+     */
+    getNodeByPath(relativePath: Array<number>): Node;
+    /**
+     * Returns the parent element of the given name. Returns null if the element is not inside the desired parent.
+     *
+     * @param parentName The name of the parent element to find.
+     * @param options Options object.
+     * @param options.includeSelf When set to `true` this node will be also included while searching.
+     */
+    findAncestor(parentName: string, options?: {
+        includeSelf?: boolean;
+    }): Element | null;
+    /**
+     * Converts `Element` instance to plain object and returns it. Takes care of converting all of this element's children.
+     *
+     * @returns `Element` instance converted to plain object.
+     */
+    toJSON(): unknown;
+    /**
+     * Creates a copy of this element and returns it. Created element has the same name and attributes as the original element.
+     * If clone is deep, the original element's children are also cloned. If not, then empty element is returned.
+     *
+     * @internal
+     * @param deep If set to `true` clones element and all its children recursively. When set to `false`,
+     * element will be cloned without any child.
+     */
+    _clone(deep?: boolean): Element;
+    /**
+     * {@link module:engine/model/element~Element#_insertChild Inserts} one or more nodes at the end of this element.
+     *
+     * @see module:engine/model/writer~Writer#append
+     * @internal
+     * @param nodes Nodes to be inserted.
+     */
+    _appendChild(nodes: string | Item | Iterable<string | Item>): void;
+    /**
+     * Inserts one or more nodes at the given index and sets {@link module:engine/model/node~Node#parent parent} of these nodes
+     * to this element.
+     *
+     * @see module:engine/model/writer~Writer#insert
+     * @internal
+     * @param index Index at which nodes should be inserted.
+     * @param items Items to be inserted.
+     */
+    _insertChild(index: number, items: string | Item | Iterable<string | Item>): void;
+    /**
+     * Removes one or more nodes starting at the given index and sets
+     * {@link module:engine/model/node~Node#parent parent} of these nodes to `null`.
+     *
+     * @see module:engine/model/writer~Writer#remove
+     * @internal
+     * @param index Index of the first node to remove.
+     * @param howMany Number of nodes to remove.
+     * @returns Array containing removed nodes.
+     */
+    _removeChildren(index: number, howMany?: number): Array<Node>;
+    /**
+     * Creates an `Element` instance from given plain object (i.e. parsed JSON string).
+     * Converts `Element` children to proper nodes.
+     *
+     * @param json Plain object to be converted to `Element`.
+     * @returns `Element` instance created using given plain object.
+     */
+    static fromJSON(json: any): Element;
+}