Add warning about ILocalPtyService

Since it's restricted to the electron-sandbox layer it can only be used when valid so
there's no concern about needing @optional here. The warning is to discourage any
usage outside of the terminal as this service deals with raw events to manage/
manipulate ptys. Without going through the TerminalService this could create processes
but they wouldn't get managed or displayed.

Part of #127878
This commit is contained in:
Daniel Imms 2021-07-08 09:27:43 -07:00
parent db1bbe7fb9
commit 3ea4f3ab54

View file

@ -7,4 +7,10 @@ import { createDecorator } from 'vs/platform/instantiation/common/instantiation'
import { IPtyService } from 'vs/platform/terminal/common/terminal';
export const ILocalPtyService = createDecorator<ILocalPtyService>('localPtyService');
/**
* A service responsible for communicating with the pty host process on Electron.
*
* **This service should only be used within the terminal component.**
*/
export interface ILocalPtyService extends IPtyService { }