Skip to content

Commit

Permalink
Add doc for executeTask and openTunnel
Browse files Browse the repository at this point in the history
  • Loading branch information
alexr00 committed Jul 13, 2020
1 parent 75fc236 commit 1cd6bc0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/vs/vscode.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6285,6 +6285,10 @@ declare module 'vscode' {
* Executes a task that is managed by VS Code. The returned
* task execution can be used to terminate the task.
*
* @throws When running a ShellExecution or a ProcessExecution
* task in an environment where a new process can't be started.
* In such an environment, only CustomExecution tasks can be run.
*
* @param task the task to execute
*/
export function executeTask(task: Task): Thenable<TaskExecution>;
Expand Down
3 changes: 3 additions & 0 deletions src/vs/vscode.proposed.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,9 @@ declare module 'vscode' {
/**
* Forwards a port. If the current resolver implements RemoteAuthorityResolver:forwardPort then that will be used to make the tunnel.
* By default, openTunnel only support localhost; however, RemoteAuthorityResolver:tunnelFactory can be used to support other ips.
*
* @throws When run in an environment without a remote.
*
* @param tunnelOptions The `localPort` is a suggestion only. If that port is not available another will be chosen.
*/
export function openTunnel(tunnelOptions: TunnelOptions): Thenable<Tunnel>;
Expand Down

1 comment on commit 1cd6bc0

@alexr00
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #101857

Please sign in to comment.