EventInfo

Api-class icon class

The event object passed to event callbacks. It is used to provide information about the event as well as a tool to manipulate it.

Type parameters

Properties

  • Chevron-right icon

    name : TName
    readonly

  • Chevron-right icon

    off : () => void
    readonly

    Removes the current callback from future interactions of this event.

  • Chevron-right icon

    path : Array<object>

    Path this event has followed. See delegate.

  • Chevron-right icon

    return : undefined | TReturn

    The value which will be returned by fire.

    It's undefined by default and can be changed by an event listener:

    dataController.fire( 'getSelectedContent', ( evt ) => {
    	// This listener will make `dataController.fire( 'getSelectedContent' )`
    	// always return an empty DocumentFragment.
    	evt.return = new DocumentFragment();
    
    	// Make sure no other listeners are executed.
    	evt.stop();
    } );
    
    Copy code
  • Chevron-right icon

    source : object
    readonly

    The object that fired the event.

  • Chevron-right icon

    stop : () => void
    readonly

    Stops the event emitter to call further callbacks for this event interaction.

Methods

  • Chevron-right icon

    constructor( source, name )

    Type parameters

    TName : extends string = string
    TReturn : unknown

    Parameters

    source : object

    The emitter.

    name : TName

    The event name.