@@ -303,16 +303,16 @@ yarn playwright test --retries <retries>
303
303
304
304
VSCode Trace Extension provides an external API that adopter extensions can rely on for communication. Currently the API is limited to the following:
305
305
306
- ``` javascript
307
- getActiveExperiment (): Experiment | undefined
308
- getActiveWebviewPanels (): { [key: string]: TraceViewerPanel | undefined ; }
309
- getActiveWebviews (): vscode .WebviewView []
310
- onWebviewCreated (listener : (data : vscode .WebviewView ) => void ): void
311
- onWebviewPanelCreated (listener : (data : vscode .WebviewPanel ) => void ): void
312
- onSignalManagerSignal (event : string | symbol, listener : (... args : unknown []) => void ): void ;
313
- offSignalManagerSignal (event : string | symbol, listener : (... args : unknown []) => void ): void ;
306
+ ``` typescript
307
+ getActiveExperiment (): Experiment | undefined ;
308
+ getActiveWebviewPanels (): { [key : string ]: TraceViewerPanel | undefined ; };
309
+ getActiveWebviews (): vscode .WebviewView [];
310
+ onWebviewCreated (listener : (data : vscode .WebviewView ) => void ): void ;
311
+ onWebviewPanelCreated (listener : (data : vscode .WebviewPanel ) => void ): void ;
314
312
addTraceServerContributor (contributor : TraceServerContributor ): void ;
315
313
setHandleTraceResourceType (handleFiles : boolean , handleFolders : boolean ): void ;
314
+ onSignalManagerSignal (event : K extends SignalType , listener : (... args : [... SignalArgs <Signals [K ]>]) => void | Promise < void > ): void ;
315
+ offSignalManagerSignal (event : K extends SignalType , listener : (... args : [... SignalArgs <Signals [K ]>]) => void | Promise < void > ): void ;
316
316
```
317
317
318
318
### Using the API from Adopter Extensions
@@ -374,9 +374,9 @@ const _onExperimentOpened = (experiment: Experiment): void => {
374
374
console .log (experiment .UUID );
375
375
};
376
376
// Add a listener
377
- importedApi .onSignalManagerSignal (' experiment opened ' , _onExperimentOpened);
377
+ importedApi .onSignalManagerSignal (' EXPERIMENT_OPENED ' , _onExperimentOpened);
378
378
// Remove a listener
379
- importedApi .offSignalManagerSignal (' experiment opened ' , _onExperimentOpened);
379
+ importedApi .offSignalManagerSignal (' EXPERIMENT_OPENED ' , _onExperimentOpened);
380
380
```
381
381
382
382
If the adopter extensions needs to add a custom hook to the trace server's start/stop API, a contribution can be made by calling ` addTraceServerContributor ` .
0 commit comments