Skip to content

Commit 67b506e

Browse files
authored
Port attributes API updates (microsoft#185848)
Part of microsoft#115616
1 parent 01c7675 commit 67b506e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/vscode-dts/vscode.proposed.portsAttributes.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ declare module 'vscode' {
1616
*/
1717
Notify = 1,
1818
/**
19-
* Once the port is forwarded, open the browser to the forwarded port.
19+
* Once the port is forwarded, open the user's web browser to the forwarded port.
2020
*/
2121
OpenBrowser = 2,
2222
/**
@@ -30,11 +30,7 @@ declare module 'vscode' {
3030
/**
3131
* Do not forward the port.
3232
*/
33-
Ignore = 5,
34-
/**
35-
* Once the port is forwarded, open the browser to the forwarded port. Only open the browser the first time the port is forwarded in a session.
36-
*/
37-
OpenBrowserOnce = 6
33+
Ignore = 5
3834
}
3935

4036
/**
@@ -62,6 +58,10 @@ declare module 'vscode' {
6258
* Provides attributes for the given port. For ports that your extension doesn't know about, simply
6359
* return undefined. For example, if `providePortAttributes` is called with ports 3000 but your
6460
* extension doesn't know anything about 3000 you should return undefined.
61+
* @param port The port number of the port that attributes are being requested for.
62+
* @param pid The pid of the process that is listening on the port. If the pid is unknown, undefined will be passed.
63+
* @param commandLine The command line of the process that is listening on the port. If the command line is unknown, undefined will be passed.
64+
* @param token A cancellation token that indicates the result is no longer needed.
6565
*/
6666
providePortAttributes(port: number, pid: number | undefined, commandLine: string | undefined, token: CancellationToken): ProviderResult<PortAttributes>;
6767
}

0 commit comments

Comments
 (0)