@ckeditor/ckeditor5-engine
Version:
The editing engine of CKEditor 5 – the best browser-based rich text editor.
286 lines (285 loc) • 10.6 kB
TypeScript
/**
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
*/
/**
* @module engine/model/typecheckable
*/
import type { Marker } from './markercollection.js';
import type DocumentFragment from './documentfragment.js';
import type DocumentSelection from './documentselection.js';
import type Element from './element.js';
import type LivePosition from './liveposition.js';
import type LiveRange from './liverange.js';
import type Node from './node.js';
import type Position from './position.js';
import type Range from './range.js';
import type RootElement from './rootelement.js';
import type Selection from './selection.js';
import type Text from './text.js';
import type TextProxy from './textproxy.js';
export default abstract class TypeCheckable {
/**
* Checks whether the object is of type {@link module:engine/model/node~Node} or its subclass.
*
* This method is useful when processing model objects that are of unknown type. For example, a function
* may return a {@link module:engine/model/documentfragment~DocumentFragment} or a {@link module:engine/model/node~Node}
* that can be either a text node or an element. This method can be used to check what kind of object is returned.
*
* ```ts
* someObject.is( 'element' ); // -> true if this is an element
* someObject.is( 'node' ); // -> true if this is a node (a text node or an element)
* someObject.is( 'documentFragment' ); // -> true if this is a document fragment
* ```
*
* Since this method is also available on a range of view objects, you can prefix the type of the object with
* `model:` or `view:` to check, for example, if this is the model's or view's element:
*
* ```ts
* modelElement.is( 'model:element' ); // -> true
* modelElement.is( 'view:element' ); // -> false
* ```
*
* By using this method it is also possible to check a name of an element:
*
* ```ts
* imageElement.is( 'element', 'imageBlock' ); // -> true
* imageElement.is( 'element', 'imageBlock' ); // -> same as above
* imageElement.is( 'model:element', 'imageBlock' ); // -> same as above, but more precise
* ```
*
* @label NODE
*/
is(type: 'node' | 'model:node'): this is Node | Element | Text | RootElement;
/**
* Checks whether the object is of type {@link module:engine/model/element~Element} or its subclass.
*
* ```ts
* element.is( 'element' ); // -> true
* element.is( 'node' ); // -> true
* element.is( 'model:element' ); // -> true
* element.is( 'model:node' ); // -> true
*
* element.is( 'view:element' ); // -> false
* element.is( 'documentSelection' ); // -> false
* ```
*
* Assuming that the object being checked is an element, you can also check its
* {@link module:engine/model/element~Element#name name}:
*
* ```ts
* element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
* text.is( 'element', 'imageBlock' ); -> false
* ```
*
* @label ELEMENT
*/
is(type: 'element' | 'model:element'): this is Element | RootElement;
/**
* Checks whether the object is of type {@link module:engine/model/rootelement~RootElement}.
*
* ```ts
* rootElement.is( 'rootElement' ); // -> true
* rootElement.is( 'element' ); // -> true
* rootElement.is( 'node' ); // -> true
* rootElement.is( 'model:rootElement' ); // -> true
* rootElement.is( 'model:element' ); // -> true
* rootElement.is( 'model:node' ); // -> true
*
* rootElement.is( 'view:element' ); // -> false
* rootElement.is( 'documentFragment' ); // -> false
* ```
*
* Assuming that the object being checked is an element, you can also check its
* {@link module:engine/model/element~Element#name name}:
*
* ```ts
* rootElement.is( 'rootElement', '$root' ); // -> same as above
* ```
*
* @label ROOT_ELEMENT
*/
is(type: 'rootElement' | 'model:rootElement'): this is RootElement;
/**
* Checks whether the object is of type {@link module:engine/model/text~Text}.
*
* ```ts
* text.is( '$text' ); // -> true
* text.is( 'node' ); // -> true
* text.is( 'model:$text' ); // -> true
* text.is( 'model:node' ); // -> true
*
* text.is( 'view:$text' ); // -> false
* text.is( 'documentSelection' ); // -> false
* ```
*
* **Note:** Until version 20.0.0 this method wasn't accepting `'$text'` type. The legacy `'text'` type is still
* accepted for backward compatibility.
*
* @label TEXT
*/
is(type: '$text' | 'model:$text'): this is Text;
/**
* Checks whether the object is of type {@link module:engine/model/position~Position} or its subclass.
*
* ```ts
* position.is( 'position' ); // -> true
* position.is( 'model:position' ); // -> true
*
* position.is( 'view:position' ); // -> false
* position.is( 'documentSelection' ); // -> false
* ```
*
* @label POSITION
*/
is(type: 'position' | 'model:position'): this is Position | LivePosition;
/**
* Checks whether the object is of type {@link module:engine/model/liveposition~LivePosition}.
*
* ```ts
* livePosition.is( 'position' ); // -> true
* livePosition.is( 'model:position' ); // -> true
* livePosition.is( 'liveposition' ); // -> true
* livePosition.is( 'model:livePosition' ); // -> true
*
* livePosition.is( 'view:position' ); // -> false
* livePosition.is( 'documentSelection' ); // -> false
* ```
*
* @label LIVE_POSITION
*/
is(type: 'livePosition' | 'model:livePosition'): this is LivePosition;
/**
* Checks whether the object is of type {@link module:engine/model/range~Range} or its subclass.
*
* ```ts
* range.is( 'range' ); // -> true
* range.is( 'model:range' ); // -> true
*
* range.is( 'view:range' ); // -> false
* range.is( 'documentSelection' ); // -> false
* ```
*
* @label RANGE
*/
is(type: 'range' | 'model:range'): this is Range | LiveRange;
/**
* Checks whether the object is of type {@link module:engine/model/liverange~LiveRange}.
*
* ```ts
* liveRange.is( 'range' ); // -> true
* liveRange.is( 'model:range' ); // -> true
* liveRange.is( 'liveRange' ); // -> true
* liveRange.is( 'model:liveRange' ); // -> true
*
* liveRange.is( 'view:range' ); // -> false
* liveRange.is( 'documentSelection' ); // -> false
* ```
*
* @label LIVE_RANGE
*/
is(type: 'liveRange' | 'model:liveRange'): this is LiveRange;
/**
* Checks whether the object is of type {@link module:engine/model/documentfragment~DocumentFragment}.
*
* ```ts
* docFrag.is( 'documentFragment' ); // -> true
* docFrag.is( 'model:documentFragment' ); // -> true
*
* docFrag.is( 'view:documentFragment' ); // -> false
* docFrag.is( 'element' ); // -> false
* docFrag.is( 'node' ); // -> false
* ```
*
* @label DOCUMENT_FRAGMENT
*/
is(type: 'documentFragment' | 'model:documentFragment'): this is DocumentFragment;
/**
* Checks whether the object is of type {@link module:engine/model/selection~Selection}
* or {@link module:engine/model/documentselection~DocumentSelection}.
*
* ```ts
* selection.is( 'selection' ); // -> true
* selection.is( 'model:selection' ); // -> true
*
* selection.is( 'view:selection' ); // -> false
* selection.is( 'range' ); // -> false
* ```
*
* @label SELECTION
*/
is(type: 'selection' | 'model:selection'): this is Selection | DocumentSelection;
/**
* Checks whether the object is of type {@link module:engine/model/documentselection~DocumentSelection}.
*
* ```ts
* selection.is( 'selection' ); // -> true
* selection.is( 'documentSelection' ); // -> true
* selection.is( 'model:selection' ); // -> true
* selection.is( 'model:documentSelection' ); // -> true
*
* selection.is( 'view:selection' ); // -> false
* selection.is( 'element' ); // -> false
* selection.is( 'node' ); // -> false
* ```
*
* @label DOCUMENT_SELECTION
*/
is(type: 'documentSelection' | 'model:documentSelection'): this is DocumentSelection;
/**
* Checks whether the object is of type {@link module:engine/model/markercollection~Marker}.
*
* ```ts
* marker.is( 'marker' ); // -> true
* marker.is( 'model:marker' ); // -> true
*
* marker.is( 'view:element' ); // -> false
* marker.is( 'documentSelection' ); // -> false
* ```
*
* @label MARKER
*/
is(type: 'marker' | 'model:marker'): this is Marker;
/**
* Checks whether the object is of type {@link module:engine/model/textproxy~TextProxy}.
*
* ```ts
* textProxy.is( '$textProxy' ); // -> true
* textProxy.is( 'model:$textProxy' ); // -> true
*
* textProxy.is( 'view:$textProxy' ); // -> false
* textProxy.is( 'range' ); // -> false
* ```
*
* **Note:** Until version 20.0.0 this method wasn't accepting `'$textProxy'` type. The legacy `'textProxt'` type is still
* accepted for backward compatibility.
*
* @label TEXT_PROXY
*/
is(type: '$textProxy' | 'model:$textProxy'): this is TextProxy;
/**
* Checks whether the object is of type {@link module:engine/model/element~Element} or its subclass and has the specified `name`.
*
* ```ts
* element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
* text.is( 'element', 'imageBlock' ); -> false
* ```
*
* @label ELEMENT_NAME
*/
is<N extends string>(type: 'element' | 'model:element', name: N): this is (Element | RootElement) & {
name: N;
};
/**
* Checks whether the object is of type {@link module:engine/model/rootelement~RootElement} and has the specified `name`.
*
* ```ts
* rootElement.is( 'rootElement', '$root' );
* ```
*
* @label ROOT_ELEMENT_NAME
*/
is<N extends string>(type: 'rootElement' | 'model:rootElement', name: N): this is RootElement & {
name: N;
};
}