ConsumerFunction (engine/conversion)
@ckeditor/ckeditor5-engine/src/conversion/downcasthelpers
typedef
function
A function that is expected to consume all the consumables that were used by the element creator.
Filtering
Every day, we work hard to keep our documentation complete. Have you spotted an outdated information? Is something missing? Please report it via our issue tracker.
Parameters
element : ElementThe model element to be converted to the view structure.
consumable : ModelConsumableThe
ModelConsumablesame as inDowncastConversionApi.consumable.[ options ] : Object-
Properties
[ options.preflight ] : BooleanWhether should consume or just check if can be consumed.
Defaults to
false
Returns
Booleantrueif all consumable values were available and were consumed,falseotherwise.