@ckeditor/ckeditor5-engine 38.1.1 → 38.2.0-alpha.1

package/src/view/textproxy.js

@@ -1,124 +1,124 @@
-/**
- * @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/view/textproxy
- */
-import TypeCheckable from './typecheckable';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-/**
- * TextProxy is a wrapper for substring of {@link module:engine/view/text~Text}. Instance of this class is created by
- * {@link module:engine/view/treewalker~TreeWalker} when only a part of {@link module:engine/view/text~Text} needs to be returned.
- *
- * `TextProxy` has an API similar to {@link module:engine/view/text~Text Text} and allows to do most of the common tasks performed
- * on view nodes.
- *
- * **Note:** Some `TextProxy` instances may represent whole text node, not just a part of it.
- * See {@link module:engine/view/textproxy~TextProxy#isPartial}.
- *
- * **Note:** `TextProxy` is a readonly interface.
- *
- * **Note:** `TextProxy` instances are created on the fly basing on the current state of parent {@link module:engine/view/text~Text}.
- * Because of this it is highly unrecommended to store references to `TextProxy instances because they might get
- * invalidated due to operations on Document. Also TextProxy is not a {@link module:engine/view/node~Node} so it can not be
- * inserted as a child of {@link module:engine/view/element~Element}.
- *
- * `TextProxy` instances are created by {@link module:engine/view/treewalker~TreeWalker view tree walker}. You should not need to create
- * an instance of this class by your own.
- */
-export default class TextProxy extends TypeCheckable {
-    /**
-     * Creates a text proxy.
-     *
-     * @internal
-     * @param textNode Text node which part is represented by this text proxy.
-     * @param offsetInText Offset in {@link module:engine/view/textproxy~TextProxy#textNode text node}
-     * from which the text proxy starts.
-     * @param length Text proxy length, that is how many text node's characters, starting from `offsetInText` it represents.
-     * @constructor
-     */
-    constructor(textNode, offsetInText, length) {
-        super();
-        this.textNode = textNode;
-        if (offsetInText < 0 || offsetInText > textNode.data.length) {
-            /**
-             * Given offsetInText value is incorrect.
-             *
-             * @error view-textproxy-wrong-offsetintext
-             */
-            throw new CKEditorError('view-textproxy-wrong-offsetintext', this);
-        }
-        if (length < 0 || offsetInText + length > textNode.data.length) {
-            /**
-             * Given length value is incorrect.
-             *
-             * @error view-textproxy-wrong-length
-             */
-            throw new CKEditorError('view-textproxy-wrong-length', this);
-        }
-        this.data = textNode.data.substring(offsetInText, offsetInText + length);
-        this.offsetInText = offsetInText;
-    }
-    /**
-     * Offset size of this node.
-     */
-    get offsetSize() {
-        return this.data.length;
-    }
-    /**
-     * Flag indicating whether `TextProxy` instance covers only part of the original {@link module:engine/view/text~Text text node}
-     * (`true`) or the whole text node (`false`).
-     *
-     * This is `false` when text proxy starts at the very beginning of {@link module:engine/view/textproxy~TextProxy#textNode textNode}
-     * ({@link module:engine/view/textproxy~TextProxy#offsetInText offsetInText} equals `0`) and text proxy sizes is equal to
-     * text node size.
-     */
-    get isPartial() {
-        return this.data.length !== this.textNode.data.length;
-    }
-    /**
-     * Parent of this text proxy, which is same as parent of text node represented by this text proxy.
-     */
-    get parent() {
-        return this.textNode.parent;
-    }
-    /**
-     * Root of this text proxy, which is same as root of text node represented by this text proxy.
-     */
-    get root() {
-        return this.textNode.root;
-    }
-    /**
-     * {@link module:engine/view/document~Document View document} that owns this text proxy, or `null` if the text proxy is inside
-     * {@link module:engine/view/documentfragment~DocumentFragment document fragment}.
-     */
-    get document() {
-        return this.textNode.document;
-    }
-    /**
-     * Returns ancestors array of this text proxy.
-     *
-     * @param options Options object.
-     * @param options.includeSelf When set to `true`, textNode will be also included in parent's array.
-     * @param options.parentFirst When set to `true`, array will be sorted from text proxy parent to
-     * root element, otherwise root element will be the first item in the array.
-     * @returns Array with ancestors.
-     */
-    getAncestors(options = {}) {
-        const ancestors = [];
-        let parent = options.includeSelf ? this.textNode : this.parent;
-        while (parent !== null) {
-            ancestors[options.parentFirst ? 'push' : 'unshift'](parent);
-            parent = parent.parent;
-        }
-        return ancestors;
-    }
-}
-// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
-// Proper overload would interfere with that.
-TextProxy.prototype.is = function (type) {
-    return type === '$textProxy' || type === 'view:$textProxy' ||
-        // This are legacy values kept for backward compatibility.
-        type === 'textProxy' || type === 'view:textProxy';
-};
+/**
+ * @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/view/textproxy
+ */
+import TypeCheckable from './typecheckable.js';
+import { CKEditorError } from '@ckeditor/ckeditor5-utils';
+/**
+ * TextProxy is a wrapper for substring of {@link module:engine/view/text~Text}. Instance of this class is created by
+ * {@link module:engine/view/treewalker~TreeWalker} when only a part of {@link module:engine/view/text~Text} needs to be returned.
+ *
+ * `TextProxy` has an API similar to {@link module:engine/view/text~Text Text} and allows to do most of the common tasks performed
+ * on view nodes.
+ *
+ * **Note:** Some `TextProxy` instances may represent whole text node, not just a part of it.
+ * See {@link module:engine/view/textproxy~TextProxy#isPartial}.
+ *
+ * **Note:** `TextProxy` is a readonly interface.
+ *
+ * **Note:** `TextProxy` instances are created on the fly basing on the current state of parent {@link module:engine/view/text~Text}.
+ * Because of this it is highly unrecommended to store references to `TextProxy instances because they might get
+ * invalidated due to operations on Document. Also TextProxy is not a {@link module:engine/view/node~Node} so it can not be
+ * inserted as a child of {@link module:engine/view/element~Element}.
+ *
+ * `TextProxy` instances are created by {@link module:engine/view/treewalker~TreeWalker view tree walker}. You should not need to create
+ * an instance of this class by your own.
+ */
+export default class TextProxy extends TypeCheckable {
+    /**
+     * Creates a text proxy.
+     *
+     * @internal
+     * @param textNode Text node which part is represented by this text proxy.
+     * @param offsetInText Offset in {@link module:engine/view/textproxy~TextProxy#textNode text node}
+     * from which the text proxy starts.
+     * @param length Text proxy length, that is how many text node's characters, starting from `offsetInText` it represents.
+     * @constructor
+     */
+    constructor(textNode, offsetInText, length) {
+        super();
+        this.textNode = textNode;
+        if (offsetInText < 0 || offsetInText > textNode.data.length) {
+            /**
+             * Given offsetInText value is incorrect.
+             *
+             * @error view-textproxy-wrong-offsetintext
+             */
+            throw new CKEditorError('view-textproxy-wrong-offsetintext', this);
+        }
+        if (length < 0 || offsetInText + length > textNode.data.length) {
+            /**
+             * Given length value is incorrect.
+             *
+             * @error view-textproxy-wrong-length
+             */
+            throw new CKEditorError('view-textproxy-wrong-length', this);
+        }
+        this.data = textNode.data.substring(offsetInText, offsetInText + length);
+        this.offsetInText = offsetInText;
+    }
+    /**
+     * Offset size of this node.
+     */
+    get offsetSize() {
+        return this.data.length;
+    }
+    /**
+     * Flag indicating whether `TextProxy` instance covers only part of the original {@link module:engine/view/text~Text text node}
+     * (`true`) or the whole text node (`false`).
+     *
+     * This is `false` when text proxy starts at the very beginning of {@link module:engine/view/textproxy~TextProxy#textNode textNode}
+     * ({@link module:engine/view/textproxy~TextProxy#offsetInText offsetInText} equals `0`) and text proxy sizes is equal to
+     * text node size.
+     */
+    get isPartial() {
+        return this.data.length !== this.textNode.data.length;
+    }
+    /**
+     * Parent of this text proxy, which is same as parent of text node represented by this text proxy.
+     */
+    get parent() {
+        return this.textNode.parent;
+    }
+    /**
+     * Root of this text proxy, which is same as root of text node represented by this text proxy.
+     */
+    get root() {
+        return this.textNode.root;
+    }
+    /**
+     * {@link module:engine/view/document~Document View document} that owns this text proxy, or `null` if the text proxy is inside
+     * {@link module:engine/view/documentfragment~DocumentFragment document fragment}.
+     */
+    get document() {
+        return this.textNode.document;
+    }
+    /**
+     * Returns ancestors array of this text proxy.
+     *
+     * @param options Options object.
+     * @param options.includeSelf When set to `true`, textNode will be also included in parent's array.
+     * @param options.parentFirst When set to `true`, array will be sorted from text proxy parent to
+     * root element, otherwise root element will be the first item in the array.
+     * @returns Array with ancestors.
+     */
+    getAncestors(options = {}) {
+        const ancestors = [];
+        let parent = options.includeSelf ? this.textNode : this.parent;
+        while (parent !== null) {
+            ancestors[options.parentFirst ? 'push' : 'unshift'](parent);
+            parent = parent.parent;
+        }
+        return ancestors;
+    }
+}
+// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
+// Proper overload would interfere with that.
+TextProxy.prototype.is = function (type) {
+    return type === '$textProxy' || type === 'view:$textProxy' ||
+        // This are legacy values kept for backward compatibility.
+        type === 'textProxy' || type === 'view:textProxy';
+};

package/src/view/treewalker.d.ts

@@ -1,195 +1,195 @@
-/**
- * @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
- */
-import Position from './position';
-import type Item from './item';
-import type Range from './range';
-/**
- * Position iterator class. It allows to iterate forward and backward over the document.
- */
-export default class TreeWalker implements IterableIterator<TreeWalkerValue> {
-    /**
-     * Walking direction. Defaults `'forward'`.
-     */
-    readonly direction: TreeWalkerDirection;
-    /**
-     * Iterator boundaries.
-     *
-     * When the iterator is walking `'forward'` on the end of boundary or is walking `'backward'`
-     * on the start of boundary, then `{ done: true }` is returned.
-     *
-     * If boundaries are not defined they are set before first and after last child of the root node.
-     */
-    readonly boundaries: Range | null;
-    /**
-     * Flag indicating whether all characters from {@link module:engine/view/text~Text} should be returned as one
-     * {@link module:engine/view/text~Text} or one by one as {@link module:engine/view/textproxy~TextProxy}.
-     */
-    readonly singleCharacters: boolean;
-    /**
-     * Flag indicating whether iterator should enter elements or not. If the iterator is shallow child nodes of any
-     * iterated node will not be returned along with `elementEnd` tag.
-     */
-    readonly shallow: boolean;
-    /**
-     * Flag indicating whether iterator should ignore `elementEnd` tags. If set to `true`, walker will not
-     * return a parent node of the start position. Each {@link module:engine/view/element~Element} will be returned once.
-     * When set to `false` each element might be returned twice: for `'elementStart'` and `'elementEnd'`.
-     */
-    readonly ignoreElementEnd: boolean;
-    /**
-     * Iterator position. If start position is not defined then position depends on {@link #direction}. If direction is
-     * `'forward'` position starts form the beginning, when direction is `'backward'` position starts from the end.
-     */
-    private _position;
-    /**
-     * Start boundary parent.
-     */
-    private readonly _boundaryStartParent;
-    /**
-     * End boundary parent.
-     */
-    private readonly _boundaryEndParent;
-    /**
-     * Creates a range iterator. All parameters are optional, but you have to specify either `boundaries` or `startPosition`.
-     *
-     * @param options Object with configuration.
-     */
-    constructor(options?: TreeWalkerOptions);
-    /**
-     * Iterable interface.
-     */
-    [Symbol.iterator](): IterableIterator<TreeWalkerValue>;
-    /**
-     * Iterator position. If start position is not defined then position depends on {@link #direction}. If direction is
-     * `'forward'` position starts form the beginning, when direction is `'backward'` position starts from the end.
-     */
-    get position(): Position;
-    /**
-     * Moves {@link #position} in the {@link #direction} skipping values as long as the callback function returns `true`.
-     *
-     * For example:
-     *
-     * ```ts
-     * walker.skip( value => value.type == 'text' ); // <p>{}foo</p> -> <p>foo[]</p>
-     * walker.skip( value => true ); // Move the position to the end: <p>{}foo</p> -> <p>foo</p>[]
-     * walker.skip( value => false ); // Do not move the position.
-     * ```
-     *
-     * @param skip Callback function. Gets {@link module:engine/view/treewalker~TreeWalkerValue} and should
-     * return `true` if the value should be skipped or `false` if not.
-     */
-    skip(skip: (value: TreeWalkerValue) => boolean): void;
-    /**
-     * Gets the next tree walker's value.
-     *
-     * @returns Object implementing iterator interface, returning
-     * information about taken step.
-     */
-    next(): IteratorResult<TreeWalkerValue, undefined>;
-    /**
-     * Makes a step forward in view. Moves the {@link #position} to the next position and returns the encountered value.
-     */
-    private _next;
-    /**
-     * Makes a step backward in view. Moves the {@link #position} to the previous position and returns the encountered value.
-     */
-    private _previous;
-    /**
-     * Format returned data and adjust `previousPosition` and `nextPosition` if reach the bound of the {@link module:engine/view/text~Text}.
-     *
-     * @param type Type of step.
-     * @param item Item between old and new position.
-     * @param previousPosition Previous position of iterator.
-     * @param nextPosition Next position of iterator.
-     * @param length Length of the item.
-     */
-    private _formatReturnValue;
-}
-/**
- * Type of the step made by {@link module:engine/view/treewalker~TreeWalker}.
- * Possible values: `'elementStart'` if walker is at the beginning of a node, `'elementEnd'` if walker is at the end
- * of node, or `'text'` if walker traversed over single and multiple characters.
- * For {@link module:engine/view/text~Text} `elementStart` and `elementEnd` is not returned.
- */
-export type TreeWalkerValueType = 'elementStart' | 'elementEnd' | 'text';
-/**
- * Object returned by {@link module:engine/view/treewalker~TreeWalker} when traversing tree view.
- */
-export interface TreeWalkerValue {
-    /**
-     * Type of the step made by {@link module:engine/view/treewalker~TreeWalker}.
-     */
-    type: TreeWalkerValueType;
-    /**
-     * Item between the old and the new positions of the tree walker.
-     */
-    item: Item;
-    /**
-     * Previous position of the iterator.
-     * * Forward iteration: For `'elementEnd'` it is the last position inside the element. For all other types it is the
-     * position before the item.
-     * * Backward iteration: For `'elementStart'` it is the first position inside the element. For all other types it is
-     * the position after item.
-     * * If the position is at the beginning or at the end of the {@link module:engine/view/text~Text} it is always moved from the
-     * inside of the text to its parent just before or just after that text.
-     */
-    previousPosition: Position;
-    /**
-     * Next position of the iterator.
-     * * Forward iteration: For `'elementStart'` it is the first position inside the element. For all other types it is
-     * the position after the item.
-     * * Backward iteration: For `'elementEnd'` it is last position inside element. For all other types it is the position
-     * before the item.
-     * * If the position is at the beginning or at the end of the {@link module:engine/view/text~Text} it is always moved from the
-     * inside of the text to its parent just before or just after that text.
-     */
-    nextPosition: Position;
-    /**
-     * Length of the item. For `'elementStart'` it is `1`. For `'text'` it is
-     * the length of that text. For `'elementEnd'` it is `undefined`.
-     */
-    length?: number;
-}
-/**
- * Tree walking direction.
- */
-export type TreeWalkerDirection = 'forward' | 'backward';
-/**
- * The configuration of {@link ~TreeWalker}.
- */
-export interface TreeWalkerOptions {
-    /**
-     * Walking direction.
-     *
-     * @default 'forward'
-     */
-    direction?: TreeWalkerDirection;
-    /**
-     * Range to define boundaries of the iterator.
-     */
-    boundaries?: Range | null;
-    /**
-     * Starting position.
-     */
-    startPosition?: Position;
-    /**
-     * Flag indicating whether all characters from
-     * {@link module:engine/view/text~Text} should be returned as one {@link module:engine/view/text~Text} (`false`) or one by one as
-     * {@link module:engine/view/textproxy~TextProxy} (`true`).
-     */
-    singleCharacters?: boolean;
-    /**
-     * Flag indicating whether iterator should enter elements or not. If the
-     * iterator is shallow child nodes of any iterated node will not be returned along with `elementEnd` tag.
-     */
-    shallow?: boolean;
-    /**
-     * Flag indicating whether iterator should ignore `elementEnd`
-     * tags. If the option is true walker will not return a parent node of start position. If this option is `true`
-     * each {@link module:engine/view/element~Element} will be returned once, while if the option is `false` they might be returned
-     * twice: for `'elementStart'` and `'elementEnd'`.
-     */
-    ignoreElementEnd?: boolean;
-}
+/**
+ * @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
+ */
+import Position from './position.js';
+import type Item from './item.js';
+import type Range from './range.js';
+/**
+ * Position iterator class. It allows to iterate forward and backward over the document.
+ */
+export default class TreeWalker implements IterableIterator<TreeWalkerValue> {
+    /**
+     * Walking direction. Defaults `'forward'`.
+     */
+    readonly direction: TreeWalkerDirection;
+    /**
+     * Iterator boundaries.
+     *
+     * When the iterator is walking `'forward'` on the end of boundary or is walking `'backward'`
+     * on the start of boundary, then `{ done: true }` is returned.
+     *
+     * If boundaries are not defined they are set before first and after last child of the root node.
+     */
+    readonly boundaries: Range | null;
+    /**
+     * Flag indicating whether all characters from {@link module:engine/view/text~Text} should be returned as one
+     * {@link module:engine/view/text~Text} or one by one as {@link module:engine/view/textproxy~TextProxy}.
+     */
+    readonly singleCharacters: boolean;
+    /**
+     * Flag indicating whether iterator should enter elements or not. If the iterator is shallow child nodes of any
+     * iterated node will not be returned along with `elementEnd` tag.
+     */
+    readonly shallow: boolean;
+    /**
+     * Flag indicating whether iterator should ignore `elementEnd` tags. If set to `true`, walker will not
+     * return a parent node of the start position. Each {@link module:engine/view/element~Element} will be returned once.
+     * When set to `false` each element might be returned twice: for `'elementStart'` and `'elementEnd'`.
+     */
+    readonly ignoreElementEnd: boolean;
+    /**
+     * Iterator position. If start position is not defined then position depends on {@link #direction}. If direction is
+     * `'forward'` position starts form the beginning, when direction is `'backward'` position starts from the end.
+     */
+    private _position;
+    /**
+     * Start boundary parent.
+     */
+    private readonly _boundaryStartParent;
+    /**
+     * End boundary parent.
+     */
+    private readonly _boundaryEndParent;
+    /**
+     * Creates a range iterator. All parameters are optional, but you have to specify either `boundaries` or `startPosition`.
+     *
+     * @param options Object with configuration.
+     */
+    constructor(options?: TreeWalkerOptions);
+    /**
+     * Iterable interface.
+     */
+    [Symbol.iterator](): IterableIterator<TreeWalkerValue>;
+    /**
+     * Iterator position. If start position is not defined then position depends on {@link #direction}. If direction is
+     * `'forward'` position starts form the beginning, when direction is `'backward'` position starts from the end.
+     */
+    get position(): Position;
+    /**
+     * Moves {@link #position} in the {@link #direction} skipping values as long as the callback function returns `true`.
+     *
+     * For example:
+     *
+     * ```ts
+     * walker.skip( value => value.type == 'text' ); // <p>{}foo</p> -> <p>foo[]</p>
+     * walker.skip( value => true ); // Move the position to the end: <p>{}foo</p> -> <p>foo</p>[]
+     * walker.skip( value => false ); // Do not move the position.
+     * ```
+     *
+     * @param skip Callback function. Gets {@link module:engine/view/treewalker~TreeWalkerValue} and should
+     * return `true` if the value should be skipped or `false` if not.
+     */
+    skip(skip: (value: TreeWalkerValue) => boolean): void;
+    /**
+     * Gets the next tree walker's value.
+     *
+     * @returns Object implementing iterator interface, returning
+     * information about taken step.
+     */
+    next(): IteratorResult<TreeWalkerValue, undefined>;
+    /**
+     * Makes a step forward in view. Moves the {@link #position} to the next position and returns the encountered value.
+     */
+    private _next;
+    /**
+     * Makes a step backward in view. Moves the {@link #position} to the previous position and returns the encountered value.
+     */
+    private _previous;
+    /**
+     * Format returned data and adjust `previousPosition` and `nextPosition` if reach the bound of the {@link module:engine/view/text~Text}.
+     *
+     * @param type Type of step.
+     * @param item Item between old and new position.
+     * @param previousPosition Previous position of iterator.
+     * @param nextPosition Next position of iterator.
+     * @param length Length of the item.
+     */
+    private _formatReturnValue;
+}
+/**
+ * Type of the step made by {@link module:engine/view/treewalker~TreeWalker}.
+ * Possible values: `'elementStart'` if walker is at the beginning of a node, `'elementEnd'` if walker is at the end
+ * of node, or `'text'` if walker traversed over single and multiple characters.
+ * For {@link module:engine/view/text~Text} `elementStart` and `elementEnd` is not returned.
+ */
+export type TreeWalkerValueType = 'elementStart' | 'elementEnd' | 'text';
+/**
+ * Object returned by {@link module:engine/view/treewalker~TreeWalker} when traversing tree view.
+ */
+export interface TreeWalkerValue {
+    /**
+     * Type of the step made by {@link module:engine/view/treewalker~TreeWalker}.
+     */
+    type: TreeWalkerValueType;
+    /**
+     * Item between the old and the new positions of the tree walker.
+     */
+    item: Item;
+    /**
+     * Previous position of the iterator.
+     * * Forward iteration: For `'elementEnd'` it is the last position inside the element. For all other types it is the
+     * position before the item.
+     * * Backward iteration: For `'elementStart'` it is the first position inside the element. For all other types it is
+     * the position after item.
+     * * If the position is at the beginning or at the end of the {@link module:engine/view/text~Text} it is always moved from the
+     * inside of the text to its parent just before or just after that text.
+     */
+    previousPosition: Position;
+    /**
+     * Next position of the iterator.
+     * * Forward iteration: For `'elementStart'` it is the first position inside the element. For all other types it is
+     * the position after the item.
+     * * Backward iteration: For `'elementEnd'` it is last position inside element. For all other types it is the position
+     * before the item.
+     * * If the position is at the beginning or at the end of the {@link module:engine/view/text~Text} it is always moved from the
+     * inside of the text to its parent just before or just after that text.
+     */
+    nextPosition: Position;
+    /**
+     * Length of the item. For `'elementStart'` it is `1`. For `'text'` it is
+     * the length of that text. For `'elementEnd'` it is `undefined`.
+     */
+    length?: number;
+}
+/**
+ * Tree walking direction.
+ */
+export type TreeWalkerDirection = 'forward' | 'backward';
+/**
+ * The configuration of {@link ~TreeWalker}.
+ */
+export interface TreeWalkerOptions {
+    /**
+     * Walking direction.
+     *
+     * @default 'forward'
+     */
+    direction?: TreeWalkerDirection;
+    /**
+     * Range to define boundaries of the iterator.
+     */
+    boundaries?: Range | null;
+    /**
+     * Starting position.
+     */
+    startPosition?: Position;
+    /**
+     * Flag indicating whether all characters from
+     * {@link module:engine/view/text~Text} should be returned as one {@link module:engine/view/text~Text} (`false`) or one by one as
+     * {@link module:engine/view/textproxy~TextProxy} (`true`).
+     */
+    singleCharacters?: boolean;
+    /**
+     * Flag indicating whether iterator should enter elements or not. If the
+     * iterator is shallow child nodes of any iterated node will not be returned along with `elementEnd` tag.
+     */
+    shallow?: boolean;
+    /**
+     * Flag indicating whether iterator should ignore `elementEnd`
+     * tags. If the option is true walker will not return a parent node of start position. If this option is `true`
+     * each {@link module:engine/view/element~Element} will be returned once, while if the option is `false` they might be returned
+     * twice: for `'elementStart'` and `'elementEnd'`.
+     */
+    ignoreElementEnd?: boolean;
+}