Skip to content

Parameterize ProgressEvent #707

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 12, 2019
Merged

Parameterize ProgressEvent #707

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c89121e
Revert "Restore FileReaderProgressEvent (#704)"
saschanaz Jun 5, 2019
c157267
Parameterize ProgressEvent
saschanaz Jun 5, 2019
8a8bb00
use generic for existing types
saschanaz Jun 5, 2019
e4a944d
emit parameterized ProgressEvent
saschanaz Jun 10, 2019
4f338ac
use existing `type-parameters` field
saschanaz Jun 12, 2019
8c699e7
ensure attributeless events get type param in the future
saschanaz Jun 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 29 additions & 34 deletions baselines/dom.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1953,7 +1953,7 @@ interface ApplicationCacheEventMap {
"error": Event;
"noupdate": Event;
"obsolete": Event;
"progress": ProgressEvent;
"progress": ProgressEvent<ApplicationCache>;
"updateready": Event;
}

Expand All @@ -1971,7 +1971,7 @@ interface ApplicationCache extends EventTarget {
/** @deprecated */
onobsolete: ((this: ApplicationCache, ev: Event) => any) | null;
/** @deprecated */
onprogress: ((this: ApplicationCache, ev: ProgressEvent) => any) | null;
onprogress: ((this: ApplicationCache, ev: ProgressEvent<ApplicationCache>) => any) | null;
/** @deprecated */
onupdateready: ((this: ApplicationCache, ev: Event) => any) | null;
/** @deprecated */
Expand Down Expand Up @@ -4286,7 +4286,7 @@ interface DocumentEventMap extends GlobalEventHandlersEventMap, DocumentAndEleme
"fullscreenerror": Event;
"pointerlockchange": Event;
"pointerlockerror": Event;
"readystatechange": ProgressEvent;
"readystatechange": ProgressEvent<Document>;
"visibilitychange": Event;
}

Expand Down Expand Up @@ -4445,7 +4445,7 @@ interface Document extends Node, NonElementParentNode, DocumentOrShadowRoot, Par
* Fires when the state of the object has changed.
* @param ev The event
*/
onreadystatechange: ((this: Document, ev: ProgressEvent) => any) | null;
onreadystatechange: ((this: Document, ev: ProgressEvent<Document>) => any) | null;
onvisibilitychange: ((this: Document, ev: Event) => any) | null;
/**
* Returns document's origin.
Expand Down Expand Up @@ -4558,7 +4558,6 @@ interface Document extends Node, NonElementParentNode, DocumentOrShadowRoot, Par
createEvent(eventInterface: "ErrorEvent"): ErrorEvent;
createEvent(eventInterface: "Event"): Event;
createEvent(eventInterface: "Events"): Event;
createEvent(eventInterface: "FileReaderProgressEvent"): FileReaderProgressEvent;
createEvent(eventInterface: "FocusEvent"): FocusEvent;
createEvent(eventInterface: "FocusNavigationEvent"): FocusNavigationEvent;
createEvent(eventInterface: "GamepadEvent"): GamepadEvent;
Expand Down Expand Up @@ -4808,7 +4807,6 @@ interface DocumentEvent {
createEvent(eventInterface: "ErrorEvent"): ErrorEvent;
createEvent(eventInterface: "Event"): Event;
createEvent(eventInterface: "Events"): Event;
createEvent(eventInterface: "FileReaderProgressEvent"): FileReaderProgressEvent;
createEvent(eventInterface: "FocusEvent"): FocusEvent;
createEvent(eventInterface: "FocusNavigationEvent"): FocusNavigationEvent;
createEvent(eventInterface: "GamepadEvent"): GamepadEvent;
Expand Down Expand Up @@ -5370,23 +5368,23 @@ declare var FileList: {
};

interface FileReaderEventMap {
"abort": FileReaderProgressEvent;
"error": FileReaderProgressEvent;
"load": FileReaderProgressEvent;
"loadend": FileReaderProgressEvent;
"loadstart": FileReaderProgressEvent;
"progress": FileReaderProgressEvent;
"abort": ProgressEvent<FileReader>;
"error": ProgressEvent<FileReader>;
"load": ProgressEvent<FileReader>;
"loadend": ProgressEvent<FileReader>;
"loadstart": ProgressEvent<FileReader>;
"progress": ProgressEvent<FileReader>;
}

/** Lets web applications asynchronously read the contents of files (or raw data buffers) stored on the user's computer, using File or Blob objects to specify the file or data to read. */
interface FileReader extends EventTarget {
readonly error: DOMException | null;
onabort: ((this: FileReader, ev: FileReaderProgressEvent) => any) | null;
onerror: ((this: FileReader, ev: FileReaderProgressEvent) => any) | null;
onload: ((this: FileReader, ev: FileReaderProgressEvent) => any) | null;
onloadend: ((this: FileReader, ev: FileReaderProgressEvent) => any) | null;
onloadstart: ((this: FileReader, ev: FileReaderProgressEvent) => any) | null;
onprogress: ((this: FileReader, ev: FileReaderProgressEvent) => any) | null;
onabort: ((this: FileReader, ev: ProgressEvent<FileReader>) => any) | null;
onerror: ((this: FileReader, ev: ProgressEvent<FileReader>) => any) | null;
onload: ((this: FileReader, ev: ProgressEvent<FileReader>) => any) | null;
onloadend: ((this: FileReader, ev: ProgressEvent<FileReader>) => any) | null;
onloadstart: ((this: FileReader, ev: ProgressEvent<FileReader>) => any) | null;
onprogress: ((this: FileReader, ev: ProgressEvent<FileReader>) => any) | null;
readonly readyState: number;
readonly result: string | ArrayBuffer | null;
abort(): void;
Expand All @@ -5411,10 +5409,6 @@ declare var FileReader: {
readonly LOADING: number;
};

interface FileReaderProgressEvent extends ProgressEvent {
readonly target: FileReader | null;
}

/** Focus-related events like focus, blur, focusin, or focusout. */
interface FocusEvent extends UIEvent {
readonly relatedTarget: EventTarget;
Expand Down Expand Up @@ -11765,9 +11759,10 @@ declare var ProcessingInstruction: {
};

/** Events measuring progress of an underlying process, like an HTTP request (for an XMLHttpRequest, or the loading of the underlying resource of an <img>, <audio>, <video>, <style> or <link>). */
interface ProgressEvent extends Event {
interface ProgressEvent<T extends EventTarget = EventTarget> extends Event {
readonly lengthComputable: boolean;
readonly loaded: number;
readonly target: T | null;
readonly total: number;
}

Expand Down Expand Up @@ -17246,9 +17241,9 @@ interface WindowEventMap extends GlobalEventHandlersEventMap, WindowEventHandler
"play": Event;
"playing": Event;
"popstate": PopStateEvent;
"progress": ProgressEvent;
"progress": ProgressEvent<Window>;
"ratechange": Event;
"readystatechange": ProgressEvent;
"readystatechange": ProgressEvent<Window>;
"reset": Event;
"resize": UIEvent;
"scroll": Event;
Expand Down Expand Up @@ -17332,7 +17327,7 @@ interface Window extends EventTarget, WindowTimers, WindowSessionStorage, Window
onmspointerup: ((this: Window, ev: Event) => any) | null;
/** @deprecated */
onorientationchange: ((this: Window, ev: Event) => any) | null;
onreadystatechange: ((this: Window, ev: ProgressEvent) => any) | null;
onreadystatechange: ((this: Window, ev: ProgressEvent<Window>) => any) | null;
onvrdisplayactivate: ((this: Window, ev: Event) => any) | null;
onvrdisplayblur: ((this: Window, ev: Event) => any) | null;
onvrdisplayconnect: ((this: Window, ev: Event) => any) | null;
Expand Down Expand Up @@ -17684,13 +17679,13 @@ declare var XMLHttpRequest: {
};

interface XMLHttpRequestEventTargetEventMap {
"abort": ProgressEvent;
"error": ProgressEvent;
"load": ProgressEvent;
"loadend": ProgressEvent;
"loadstart": ProgressEvent;
"progress": ProgressEvent;
"timeout": ProgressEvent;
"abort": ProgressEvent<XMLHttpRequestEventTarget>;
"error": ProgressEvent<XMLHttpRequestEventTarget>;
"load": ProgressEvent<XMLHttpRequestEventTarget>;
"loadend": ProgressEvent<XMLHttpRequestEventTarget>;
"loadstart": ProgressEvent<XMLHttpRequestEventTarget>;
"progress": ProgressEvent<XMLHttpRequestEventTarget>;
"timeout": ProgressEvent<XMLHttpRequestEventTarget>;
}

interface XMLHttpRequestEventTarget extends EventTarget {
Expand Down Expand Up @@ -18328,7 +18323,7 @@ declare var onmspointerover: ((this: Window, ev: Event) => any) | null;
declare var onmspointerup: ((this: Window, ev: Event) => any) | null;
/** @deprecated */
declare var onorientationchange: ((this: Window, ev: Event) => any) | null;
declare var onreadystatechange: ((this: Window, ev: ProgressEvent) => any) | null;
declare var onreadystatechange: ((this: Window, ev: ProgressEvent<Window>) => any) | null;
declare var onvrdisplayactivate: ((this: Window, ev: Event) => any) | null;
declare var onvrdisplayblur: ((this: Window, ev: Event) => any) | null;
declare var onvrdisplayconnect: ((this: Window, ev: Event) => any) | null;
Expand Down
45 changes: 21 additions & 24 deletions baselines/webworker.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1525,23 +1525,23 @@ declare var FileList: {
};

interface FileReaderEventMap {
"abort": FileReaderProgressEvent;
"error": FileReaderProgressEvent;
"load": FileReaderProgressEvent;
"loadend": FileReaderProgressEvent;
"loadstart": FileReaderProgressEvent;
"progress": FileReaderProgressEvent;
"abort": ProgressEvent<FileReader>;
"error": ProgressEvent<FileReader>;
"load": ProgressEvent<FileReader>;
"loadend": ProgressEvent<FileReader>;
"loadstart": ProgressEvent<FileReader>;
"progress": ProgressEvent<FileReader>;
}

/** Lets web applications asynchronously read the contents of files (or raw data buffers) stored on the user's computer, using File or Blob objects to specify the file or data to read. */
interface FileReader extends EventTarget {
readonly error: DOMException | null;
onabort: ((this: FileReader, ev: FileReaderProgressEvent) => any) | null;
onerror: ((this: FileReader, ev: FileReaderProgressEvent) => any) | null;
onload: ((this: FileReader, ev: FileReaderProgressEvent) => any) | null;
onloadend: ((this: FileReader, ev: FileReaderProgressEvent) => any) | null;
onloadstart: ((this: FileReader, ev: FileReaderProgressEvent) => any) | null;
onprogress: ((this: FileReader, ev: FileReaderProgressEvent) => any) | null;
onabort: ((this: FileReader, ev: ProgressEvent<FileReader>) => any) | null;
onerror: ((this: FileReader, ev: ProgressEvent<FileReader>) => any) | null;
onload: ((this: FileReader, ev: ProgressEvent<FileReader>) => any) | null;
onloadend: ((this: FileReader, ev: ProgressEvent<FileReader>) => any) | null;
onloadstart: ((this: FileReader, ev: ProgressEvent<FileReader>) => any) | null;
onprogress: ((this: FileReader, ev: ProgressEvent<FileReader>) => any) | null;
readonly readyState: number;
readonly result: string | ArrayBuffer | null;
abort(): void;
Expand All @@ -1566,10 +1566,6 @@ declare var FileReader: {
readonly LOADING: number;
};

interface FileReaderProgressEvent extends ProgressEvent {
readonly target: FileReader | null;
}

/** Allows to read File or Blob objects in a synchronous way. */
interface FileReaderSync {
readAsArrayBuffer(blob: Blob): ArrayBuffer;
Expand Down Expand Up @@ -2587,9 +2583,10 @@ declare var Permissions: {
};

/** Events measuring progress of an underlying process, like an HTTP request (for an XMLHttpRequest, or the loading of the underlying resource of an <img>, <audio>, <video>, <style> or <link>). */
interface ProgressEvent extends Event {
interface ProgressEvent<T extends EventTarget = EventTarget> extends Event {
readonly lengthComputable: boolean;
readonly loaded: number;
readonly target: T | null;
readonly total: number;
}

Expand Down Expand Up @@ -4513,13 +4510,13 @@ declare var XMLHttpRequest: {
};

interface XMLHttpRequestEventTargetEventMap {
"abort": ProgressEvent;
"error": ProgressEvent;
"load": ProgressEvent;
"loadend": ProgressEvent;
"loadstart": ProgressEvent;
"progress": ProgressEvent;
"timeout": ProgressEvent;
"abort": ProgressEvent<XMLHttpRequestEventTarget>;
"error": ProgressEvent<XMLHttpRequestEventTarget>;
"load": ProgressEvent<XMLHttpRequestEventTarget>;
"loadend": ProgressEvent<XMLHttpRequestEventTarget>;
"loadstart": ProgressEvent<XMLHttpRequestEventTarget>;
"progress": ProgressEvent<XMLHttpRequestEventTarget>;
"timeout": ProgressEvent<XMLHttpRequestEventTarget>;
}

interface XMLHttpRequestEventTarget extends EventTarget {
Expand Down
34 changes: 25 additions & 9 deletions inputfiles/addedTypes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,8 +599,14 @@
}
}
},
"NodeListOf<TNode extends Node>": {
"name": "NodeListOf<TNode extends Node>",
"NodeListOf": {
"name": "NodeListOf",
"type-parameters": [
{
"name": "TNode",
"extends": "Node"
}
],
"exposed": "Window",
"extends": "NodeList",
"properties": {
Expand Down Expand Up @@ -634,8 +640,14 @@
]
}
},
"HTMLCollectionOf<T extends Element>": {
"name": "HTMLCollectionOf<T extends Element>",
"HTMLCollectionOf": {
"name": "HTMLCollectionOf",
"type-parameters": [
{
"name": "T",
"extends": "Element"
}
],
"exposed": "Window",
"extends": "HTMLCollection",
"methods": {
Expand Down Expand Up @@ -2175,17 +2187,21 @@
}
}
},
"FileReaderProgressEvent": {
"name": "FileReaderProgressEvent",
"extends": "ProgressEvent",
"no-interface-object": 1,
"ProgressEvent": {
"type-parameters": [
{
"name": "T",
"extends": "EventTarget",
"default": "EventTarget"
}
],
"properties": {
"property": {
"target": {
"name": "target",
"read-only": 1,
"nullable": 1,
"type": "FileReader"
"override-type": "T"
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion inputfiles/comments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@
}
}
},
"NodeListOf<TNode extends Node>": {
"NodeListOf": {
"methods": {
"method": {
"forEach": {
Expand Down
12 changes: 6 additions & 6 deletions inputfiles/overridingTypes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1862,27 +1862,27 @@
"event": [
{
"name": "loadstart",
"type": "FileReaderProgressEvent"
"type": "ProgressEvent"
},
{
"name": "progress",
"type": "FileReaderProgressEvent"
"type": "ProgressEvent"
},
{
"name": "load",
"type": "FileReaderProgressEvent"
"type": "ProgressEvent"
},
{
"name": "abort",
"type": "FileReaderProgressEvent"
"type": "ProgressEvent"
},
{
"name": "error",
"type": "FileReaderProgressEvent"
"type": "ProgressEvent"
},
{
"name": "loadend",
"type": "FileReaderProgressEvent"
"type": "ProgressEvent"
}
]
}
Expand Down
Loading