-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
eventinfo.ts
73 lines (63 loc) · 1.86 KB
/
eventinfo.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/**
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module utils/eventinfo
*/
import spy from './spy';
/**
* The event object passed to event callbacks. It is used to provide information about the event as well as a tool to
* manipulate it.
*/
export default class EventInfo<TName extends string = string, TReturn = unknown> {
/**
* The object that fired the event.
*/
public readonly source: object;
/**
* The event name.
*/
public readonly name: TName;
/**
* Path this event has followed. See {@link module:utils/emittermixin~Emitter#delegate}.
*/
public path: Array<object>;
/**
* Stops the event emitter to call further callbacks for this event interaction.
*/
public readonly stop: { (): void; called?: boolean };
/**
* Removes the current callback from future interactions of this event.
*/
public readonly off: { (): void; called?: boolean };
/**
* The value which will be returned by {@link module:utils/emittermixin~Emitter#fire}.
*
* It's `undefined` by default and can be changed by an event listener:
*
* ```ts
* 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();
* } );
* ```
*/
public return: TReturn | undefined;
/**
* @param source The emitter.
* @param name The event name.
*/
constructor( source: object, name: TName ) {
this.source = source;
this.name = name;
this.path = [];
// The following methods are defined in the constructor because they must be re-created per instance.
this.stop = spy();
this.off = spy();
}
}