Skip to content

Commit

Permalink
Add note on lifecycle of resolved result
Browse files Browse the repository at this point in the history
  • Loading branch information
mjbvz committed Sep 24, 2019
1 parent 31d946d commit 565cada
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/vs/vscode.proposed.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1152,7 +1152,12 @@ declare module 'vscode' {
* If the extension is running remotely, this function automatically establishes port forwarding from
* the local machine to `target` on the remote and returns a local uri that can be used to for this connection.
*
* Note that uris passed through `openExternal` are automatically resolved.
* Extensions should not store the result of `resolveExternalUri` as the resolved uri may become invalid due to
* a system or user action — for example, in remote cases, a user may close a port that was forwarded by
* `resolveExternalUri`.
*
* Note: uris passed through `openExternal` are automatically resolved and you should not call `resolveExternalUri`
* on them.
*
* @return A uri that can be used on the client machine.
*/
Expand Down

0 comments on commit 565cada

Please sign in to comment.