function

connect

typescript
connect(connectionParams: ConnectionParameters): Promise<{ disconnect: () => void; isConnected: () => boolean; useRemote: () => void; useRemoteClipboard: () => void; useRemoteKeyboard: () => void; useRemoteMouse: () => void; useRemoteScreen: () => void }>

Parameters

NameTypeDescription
connectionParamsConnectionParametersThe connection parameters (host, port, credentials, etc.)

Returns

Promise<{ disconnect: () => void; isConnected: () => boolean; useRemote: () => void; useRemoteClipboard: () => void; useRemoteKeyboard: () => void; useRemoteMouse: () => void; useRemoteScreen: () => void }>

Was this page helpful?