Skip to content

Commit 165ac11

Browse files
williamsyang-workbhufmann
authored andcommittedDec 9, 2024
Update External API Documentation in README
Signed-off-by: William Yang <willliam.yang@ericsson.com>
1 parent f976ef5 commit 165ac11

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed
 

‎README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -303,16 +303,16 @@ yarn playwright test --retries <retries>
303303

304304
VSCode Trace Extension provides an external API that adopter extensions can rely on for communication. Currently the API is limited to the following:
305305

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;
314312
addTraceServerContributor(contributor: TraceServerContributor): void;
315313
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;
316316
```
317317

318318
### Using the API from Adopter Extensions
@@ -374,9 +374,9 @@ const _onExperimentOpened = (experiment: Experiment): void => {
374374
console.log(experiment.UUID);
375375
};
376376
//Add a listener
377-
importedApi.onSignalManagerSignal('experiment opened', _onExperimentOpened);
377+
importedApi.onSignalManagerSignal('EXPERIMENT_OPENED', _onExperimentOpened);
378378
//Remove a listener
379-
importedApi.offSignalManagerSignal('experiment opened', _onExperimentOpened);
379+
importedApi.offSignalManagerSignal('EXPERIMENT_OPENED', _onExperimentOpened);
380380
```
381381

382382
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

Comments
 (0)