CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

utils/emittermixin

@ckeditor/ckeditor5-utils/src/emittermixin

module

Filtering

Interfaces

Functions

  • _getEmitterId( emitter )

    protected

    Returns emitter's unique id.

    See source

    Parameters

    emitter : Emitter

    An emitter which id will be returned.

  • _getEmitterListenedTo( listeningEmitter, listenedToEmitterId ) → Emitter | null

    protected

    Checks if listeningEmitter listens to an emitter with given listenedToEmitterId and if so, returns that emitter. If not, returns null.

    See source

    Parameters

    listeningEmitter : Emitter

    An emitter that listens.

    listenedToEmitterId : String

    Unique emitter id of emitter listened to.

    Returns

    Emitter | null

  • _setEmitterId( emitter, [ id ] )

    protected

    Sets emitter's unique id.

    See source

    Note: _emitterId can be set only once.

    Parameters

    emitter : Emitter

    An emitter for which id will be set.

    [ id ] : String

    Unique id to set. If not passed, random unique id will be set.