TypeCheckable (engine/model)

@ckeditor/ckeditor5-engine/src/model/typecheckable

Methods

• is( type ) → this is Node | Text | Element | RootElementmodule:engine/model/typecheckable~TypeCheckable#is:NODE

  See source

  Checks whether the object is of type Node or its subclass.

  This method is useful when processing model objects that are of unknown type. For example, a function may return a DocumentFragment or a Node that can be either a text node or an element. This method can be used to check what kind of object is returned.

  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:

  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:

  imageElement.is( 'element', 'imageBlock' ); // -> true
  imageElement.is( 'element', 'imageBlock' ); // -> same as above
  imageElement.is( 'model:element', 'imageBlock' ); // -> same as above, but more precise
  

  Parameters

  type : 'node' | 'model:node'

  Returns

  this is Node | Text | Element | RootElement

• is( type ) → this is Element | RootElementmodule:engine/model/typecheckable~TypeCheckable#is:ELEMENT

  See source

  Checks whether the object is of type Element or its subclass.

  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 name:

  element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
  text.is( 'element', 'imageBlock' ); -> false
  

  Parameters

  type : 'element' | 'model:element'

  Returns

  this is Element | RootElement

• is( type ) → this is Textmodule:engine/model/typecheckable~TypeCheckable#is:TEXT

  See source

  Checks whether the object is of type Text.

  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.

  Parameters

  type : '$text' | 'model:$text'

  Returns

  this is Text

• is( type ) → this is LivePositionmodule:engine/model/typecheckable~TypeCheckable#is:LIVE_POSITION

  See source

  Checks whether the object is of type LivePosition.

  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
  

  Parameters

  type : 'livePosition' | 'model:livePosition'

  Returns

  this is LivePosition

• is( type ) → this is LiveRangemodule:engine/model/typecheckable~TypeCheckable#is:LIVE_RANGE

  See source

  Checks whether the object is of type LiveRange.

  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
  

  Parameters

  type : 'liveRange' | 'model:liveRange'

  Returns

  this is LiveRange

• is( type ) → this is Selection | DocumentSelectionmodule:engine/model/typecheckable~TypeCheckable#is:SELECTION

  See source

  Checks whether the object is of type Selection or DocumentSelection.

  selection.is( 'selection' ); // -> true
  selection.is( 'model:selection' ); // -> true
  
  selection.is( 'view:selection' ); // -> false
  selection.is( 'range' ); // -> false
  

  Parameters

  type : 'selection' | 'model:selection'

  Returns

  this is Selection | DocumentSelection

• is( type ) → this is Markermodule:engine/model/typecheckable~TypeCheckable#is:MARKER

  See source

  Checks whether the object is of type Marker.

  marker.is( 'marker' ); // -> true
  marker.is( 'model:marker' ); // -> true
  
  marker.is( 'view:element' ); // -> false
  marker.is( 'documentSelection' ); // -> false
  

  Parameters

  type : 'marker' | 'model:marker'

  Returns

  this is Marker

• is( type, name ) → booleanmodule:engine/model/typecheckable~TypeCheckable#is:ELEMENT_NAME

  See source

  Checks whether the object is of type Element or its subclass and has the specified name.

  element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
  text.is( 'element', 'imageBlock' ); -> false
  

  Type parameters

  N : extends string

  Parameters

  type : 'element' | 'model:element'

  name : N

  Returns

  boolean

• is( type, name ) → booleanmodule:engine/model/typecheckable~TypeCheckable#is:ROOT_ELEMENT_NAME

  See source

  Checks whether the object is of type RootElement and has the specified name.

  rootElement.is( 'rootElement', '$root' );
  

  Type parameters

  N : extends string

  Parameters

  type : 'rootElement' | 'model:rootElement'

  name : N

  Returns

  boolean

• is( type ) → this is TextProxymodule:engine/model/typecheckable~TypeCheckable#is:TEXT_PROXY

  See source

  Checks whether the object is of type TextProxy.

  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.

  Parameters

  type : '$textProxy' | 'model:$textProxy'

  Returns

  this is TextProxy

• is( type ) → this is DocumentSelectionmodule:engine/model/typecheckable~TypeCheckable#is:DOCUMENT_SELECTION

  See source

  Checks whether the object is of type DocumentSelection.

  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
  

  Parameters

  type : 'documentSelection' | 'model:documentSelection'

  Returns

  this is DocumentSelection

• is( type ) → this is DocumentFragmentmodule:engine/model/typecheckable~TypeCheckable#is:DOCUMENT_FRAGMENT

  See source

  Checks whether the object is of type DocumentFragment.

  docFrag.is( 'documentFragment' ); // -> true
  docFrag.is( 'model:documentFragment' ); // -> true
  
  docFrag.is( 'view:documentFragment' ); // -> false
  docFrag.is( 'element' ); // -> false
  docFrag.is( 'node' ); // -> false
  

  Parameters

  type : 'documentFragment' | 'model:documentFragment'

  Returns

  this is DocumentFragment

• is( type ) → this is Range | LiveRangemodule:engine/model/typecheckable~TypeCheckable#is:RANGE

  See source

  Checks whether the object is of type Range or its subclass.

  range.is( 'range' ); // -> true
  range.is( 'model:range' ); // -> true
  
  range.is( 'view:range' ); // -> false
  range.is( 'documentSelection' ); // -> false
  

  Parameters

  type : 'range' | 'model:range'

  Returns

  this is Range | LiveRange

• is( type ) → this is Position | LivePositionmodule:engine/model/typecheckable~TypeCheckable#is:POSITION

  See source

  Checks whether the object is of type Position or its subclass.

  position.is( 'position' ); // -> true
  position.is( 'model:position' ); // -> true
  
  position.is( 'view:position' ); // -> false
  position.is( 'documentSelection' ); // -> false
  

  Parameters

  type : 'position' | 'model:position'

  Returns

  this is Position | LivePosition

• is( type ) → this is RootElementmodule:engine/model/typecheckable~TypeCheckable#is:ROOT_ELEMENT

  See source

  Checks whether the object is of type RootElement.

  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 name:

  rootElement.is( 'rootElement', '$root' ); // -> same as above
  

  Parameters

  type : 'rootElement' | 'model:rootElement'

  Returns

  this is RootElement