Home/CKEditor 5/API

ConsumerFunction (engine/conversion)

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

typedeffunction

See source

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

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

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.

Returns

boolean | null: true if all consumable values were available and were consumed, false otherwise.

Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.

With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.