CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Typedef

ConsumerFunction (engine/conversion)

@ckeditor/ckeditor5-engine/src/conversion/downcasthelpers

typedef
function
See source

A function that is expected to consume all the consumables that were used by the element creator.

Filtering

Parameters

element : Element

The model element to be converted to the view structure.

consumable : ModelConsumable

The ModelConsumable same as in DowncastConversionApi.consumable.

[ options ] : Object
Properties
[ options.preflight ] : Boolean

Whether should consume or just check if can be consumed.

Defaults to false

Returns

Boolean

true if all consumable values were available and were consumed, false otherwise.

Related: