UNPKG

1.45 kBTypeScriptView Raw
1import { EventsKey } from './events';
2import BaseEvent from './events/Event';
3import Target from './events/Target';
4
5export default class Observable extends Target {
6 constructor();
7 /**
8 * Increases the revision counter and dispatches a 'change' event.
9 */
10 changed(): void;
11 /**
12 * Get the version number for this object. Each time the object is modified,
13 * its version number will be incremented.
14 */
15 getRevision(): number;
16 /**
17 * Listen for a certain type of event.
18 */
19 on(type: string | string[], listener: (p0: any) => any): EventsKey | EventsKey[];
20 /**
21 * Listen once for a certain type of event.
22 */
23 once(type: string | string[], listener: (p0: any) => any): EventsKey | EventsKey[];
24 /**
25 * Unlisten for a certain type of event.
26 */
27 un(type: string | string[], listener: (p0: any) => any): void;
28 on(type: 'change', listener: (evt: BaseEvent) => void): EventsKey;
29 once(type: 'change', listener: (evt: BaseEvent) => void): EventsKey;
30 un(type: 'change', listener: (evt: BaseEvent) => void): void;
31 on(type: 'error', listener: (evt: BaseEvent) => void): EventsKey;
32 once(type: 'error', listener: (evt: BaseEvent) => void): EventsKey;
33 un(type: 'error', listener: (evt: BaseEvent) => void): void;
34}
35/**
36 * Removes an event listener using the key returned by on() or once().
37 */
38export function unByKey(key: EventsKey | EventsKey[]): void;