Skip to content

Commit 868b942

Browse files
fix: types in tests-proxy (#326)
1 parent fa8c2b8 commit 868b942

File tree

3 files changed

+48
-46
lines changed

3 files changed

+48
-46
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.vscode

scripts/protocol-dts-generator.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -360,10 +360,11 @@ const emitApiEvent = (event: P.Event, domainName: string, modulePrefix: string,
360360
break;
361361
}
362362
case EventStyle.INSPECTOR_PROTOCOL_TESTS: {
363-
const eventType = event.parameters ? `{ params: ${prefix}${toEventPayloadName(event.name)} }` : ''
364-
emitLine(`on${toTitleCase(event.name)}(listener: (event: ${eventType}) => void): void;`)
365-
emitLine(`off${toTitleCase(event.name)}(listener: (event: ${eventType}) => void): void;`)
366-
emitLine(`once${toTitleCase(event.name)}(eventMatcher?: (event: ${eventType}) => boolean): Promise<${eventType}>;`)
363+
const returnType = event.parameters ? `{ params: ${prefix}${toEventPayloadName(event.name)} }`: 'void'
364+
const eventType = event.parameters ? `event: ${returnType}` : '';
365+
emitLine(`on${toTitleCase(event.name)}(listener: (${eventType}) => void): void;`)
366+
emitLine(`off${toTitleCase(event.name)}(listener: (${eventType}) => void): void;`)
367+
emitLine(`once${toTitleCase(event.name)}(eventMatcher?: (${eventType}) => boolean): Promise<${returnType}>;`)
367368
break;
368369
}
369370
}

types/protocol-tests-proxy-api.d.ts

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -360,9 +360,9 @@ export namespace ProtocolTestsProxyApi {
360360
/**
361361
* Fired when the virtual machine resumed execution.
362362
*/
363-
onResumed(listener: (event: ) => void): void;
364-
offResumed(listener: (event: ) => void): void;
365-
onceResumed(eventMatcher?: (event: ) => boolean): Promise<>;
363+
onResumed(listener: () => void): void;
364+
offResumed(listener: () => void): void;
365+
onceResumed(eventMatcher?: () => boolean): Promise<void>;
366366

367367
/**
368368
* Fired when virtual machine fails to parse the script.
@@ -434,9 +434,9 @@ export namespace ProtocolTestsProxyApi {
434434
offReportHeapSnapshotProgress(listener: (event: { params: Protocol.HeapProfiler.ReportHeapSnapshotProgressEvent }) => void): void;
435435
onceReportHeapSnapshotProgress(eventMatcher?: (event: { params: Protocol.HeapProfiler.ReportHeapSnapshotProgressEvent }) => boolean): Promise<{ params: Protocol.HeapProfiler.ReportHeapSnapshotProgressEvent }>;
436436

437-
onResetProfiles(listener: (event: ) => void): void;
438-
offResetProfiles(listener: (event: ) => void): void;
439-
onceResetProfiles(eventMatcher?: (event: ) => boolean): Promise<>;
437+
onResetProfiles(listener: () => void): void;
438+
offResetProfiles(listener: () => void): void;
439+
onceResetProfiles(eventMatcher?: () => boolean): Promise<void>;
440440

441441
}
442442

@@ -670,9 +670,9 @@ export namespace ProtocolTestsProxyApi {
670670
/**
671671
* Issued when all executionContexts were cleared in browser
672672
*/
673-
onExecutionContextsCleared(listener: (event: ) => void): void;
674-
offExecutionContextsCleared(listener: (event: ) => void): void;
675-
onceExecutionContextsCleared(eventMatcher?: (event: ) => boolean): Promise<>;
673+
onExecutionContextsCleared(listener: () => void): void;
674+
offExecutionContextsCleared(listener: () => void): void;
675+
onceExecutionContextsCleared(eventMatcher?: () => boolean): Promise<void>;
676676

677677
/**
678678
* Issued when object should be inspected (for example, as a result of inspect() command line API
@@ -1330,9 +1330,9 @@ export namespace ProtocolTestsProxyApi {
13301330
* Fires whenever a MediaQuery result changes (for example, after a browser window has been
13311331
* resized.) The current implementation considers only viewport-dependent media features.
13321332
*/
1333-
onMediaQueryResultChanged(listener: (event: ) => void): void;
1334-
offMediaQueryResultChanged(listener: (event: ) => void): void;
1335-
onceMediaQueryResultChanged(eventMatcher?: (event: ) => boolean): Promise<>;
1333+
onMediaQueryResultChanged(listener: () => void): void;
1334+
offMediaQueryResultChanged(listener: () => void): void;
1335+
onceMediaQueryResultChanged(eventMatcher?: () => boolean): Promise<void>;
13361336

13371337
/**
13381338
* Fired whenever an active document stylesheet is added.
@@ -1789,9 +1789,9 @@ export namespace ProtocolTestsProxyApi {
17891789
/**
17901790
* Fired when `Document` has been totally updated. Node ids are no longer valid.
17911791
*/
1792-
onDocumentUpdated(listener: (event: ) => void): void;
1793-
offDocumentUpdated(listener: (event: ) => void): void;
1794-
onceDocumentUpdated(eventMatcher?: (event: ) => boolean): Promise<>;
1792+
onDocumentUpdated(listener: () => void): void;
1793+
offDocumentUpdated(listener: () => void): void;
1794+
onceDocumentUpdated(eventMatcher?: () => boolean): Promise<void>;
17951795

17961796
/**
17971797
* Fired when `Element`'s inline style is modified via a CSS property modification.
@@ -1810,9 +1810,9 @@ export namespace ProtocolTestsProxyApi {
18101810
/**
18111811
* Called when top layer elements are changed.
18121812
*/
1813-
onTopLayerElementsUpdated(listener: (event: ) => void): void;
1814-
offTopLayerElementsUpdated(listener: (event: ) => void): void;
1815-
onceTopLayerElementsUpdated(eventMatcher?: (event: ) => boolean): Promise<>;
1813+
onTopLayerElementsUpdated(listener: () => void): void;
1814+
offTopLayerElementsUpdated(listener: () => void): void;
1815+
onceTopLayerElementsUpdated(eventMatcher?: () => boolean): Promise<void>;
18161816

18171817
/**
18181818
* Fired when a node's scrollability state changes.
@@ -2234,9 +2234,9 @@ export namespace ProtocolTestsProxyApi {
22342234
/**
22352235
* Notification sent after the virtual time budget for the current VirtualTimePolicy has run out.
22362236
*/
2237-
onVirtualTimeBudgetExpired(listener: (event: ) => void): void;
2238-
offVirtualTimeBudgetExpired(listener: (event: ) => void): void;
2239-
onceVirtualTimeBudgetExpired(eventMatcher?: (event: ) => boolean): Promise<>;
2237+
onVirtualTimeBudgetExpired(listener: () => void): void;
2238+
offVirtualTimeBudgetExpired(listener: () => void): void;
2239+
onceVirtualTimeBudgetExpired(eventMatcher?: () => boolean): Promise<void>;
22402240

22412241
}
22422242

@@ -2433,16 +2433,16 @@ export namespace ProtocolTestsProxyApi {
24332433
/**
24342434
* Fired when debugging target has crashed
24352435
*/
2436-
onTargetCrashed(listener: (event: ) => void): void;
2437-
offTargetCrashed(listener: (event: ) => void): void;
2438-
onceTargetCrashed(eventMatcher?: (event: ) => boolean): Promise<>;
2436+
onTargetCrashed(listener: () => void): void;
2437+
offTargetCrashed(listener: () => void): void;
2438+
onceTargetCrashed(eventMatcher?: () => boolean): Promise<void>;
24392439

24402440
/**
24412441
* Fired when debugging target has reloaded after crash
24422442
*/
2443-
onTargetReloadedAfterCrash(listener: (event: ) => void): void;
2444-
offTargetReloadedAfterCrash(listener: (event: ) => void): void;
2445-
onceTargetReloadedAfterCrash(eventMatcher?: (event: ) => boolean): Promise<>;
2443+
onTargetReloadedAfterCrash(listener: () => void): void;
2444+
offTargetReloadedAfterCrash(listener: () => void): void;
2445+
onceTargetReloadedAfterCrash(eventMatcher?: () => boolean): Promise<void>;
24462446

24472447
}
24482448

@@ -3056,9 +3056,9 @@ export namespace ProtocolTestsProxyApi {
30563056
/**
30573057
* Fired once security policy has been updated.
30583058
*/
3059-
onPolicyUpdated(listener: (event: ) => void): void;
3060-
offPolicyUpdated(listener: (event: ) => void): void;
3061-
oncePolicyUpdated(eventMatcher?: (event: ) => boolean): Promise<>;
3059+
onPolicyUpdated(listener: () => void): void;
3060+
offPolicyUpdated(listener: () => void): void;
3061+
oncePolicyUpdated(eventMatcher?: () => boolean): Promise<void>;
30623062

30633063
/**
30643064
* Fired once when parsing the .wbn file has succeeded.
@@ -3273,9 +3273,9 @@ export namespace ProtocolTestsProxyApi {
32733273
/**
32743274
* Fired when user cancels the inspect mode.
32753275
*/
3276-
onInspectModeCanceled(listener: (event: ) => void): void;
3277-
offInspectModeCanceled(listener: (event: ) => void): void;
3278-
onceInspectModeCanceled(eventMatcher?: (event: ) => boolean): Promise<>;
3276+
onInspectModeCanceled(listener: () => void): void;
3277+
offInspectModeCanceled(listener: () => void): void;
3278+
onceInspectModeCanceled(eventMatcher?: () => boolean): Promise<void>;
32793279

32803280
}
32813281

@@ -3655,9 +3655,9 @@ export namespace ProtocolTestsProxyApi {
36553655
offDocumentOpened(listener: (event: { params: Protocol.Page.DocumentOpenedEvent }) => void): void;
36563656
onceDocumentOpened(eventMatcher?: (event: { params: Protocol.Page.DocumentOpenedEvent }) => boolean): Promise<{ params: Protocol.Page.DocumentOpenedEvent }>;
36573657

3658-
onFrameResized(listener: (event: ) => void): void;
3659-
offFrameResized(listener: (event: ) => void): void;
3660-
onceFrameResized(eventMatcher?: (event: ) => boolean): Promise<>;
3658+
onFrameResized(listener: () => void): void;
3659+
offFrameResized(listener: () => void): void;
3660+
onceFrameResized(eventMatcher?: () => boolean): Promise<void>;
36613661

36623662
/**
36633663
* Fired when a navigation starts. This event is fired for both
@@ -3720,16 +3720,16 @@ export namespace ProtocolTestsProxyApi {
37203720
/**
37213721
* Fired when interstitial page was hidden
37223722
*/
3723-
onInterstitialHidden(listener: (event: ) => void): void;
3724-
offInterstitialHidden(listener: (event: ) => void): void;
3725-
onceInterstitialHidden(eventMatcher?: (event: ) => boolean): Promise<>;
3723+
onInterstitialHidden(listener: () => void): void;
3724+
offInterstitialHidden(listener: () => void): void;
3725+
onceInterstitialHidden(eventMatcher?: () => boolean): Promise<void>;
37263726

37273727
/**
37283728
* Fired when interstitial page was shown
37293729
*/
3730-
onInterstitialShown(listener: (event: ) => void): void;
3731-
offInterstitialShown(listener: (event: ) => void): void;
3732-
onceInterstitialShown(eventMatcher?: (event: ) => boolean): Promise<>;
3730+
onInterstitialShown(listener: () => void): void;
3731+
offInterstitialShown(listener: () => void): void;
3732+
onceInterstitialShown(eventMatcher?: () => boolean): Promise<void>;
37333733

37343734
/**
37353735
* Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been

0 commit comments

Comments
 (0)