@microsoft/dev-tunnels-connections/tunnelRelayStreamFactory.d.ts

Tunnels library for Visual Studio tools

import { Stream } from '@microsoft/dev-tunnels-ssh';
import { IClientConfig } from 'websocket';
/**
 * Interface for a factory capable of creating streams to a tunnel relay.
 */
export interface TunnelRelayStreamFactory {
    /**
     * Creates a stream connected to a tunnel relay URI.
     * @param relayUri URI of the tunnel relay to connect to.
     * @param protocols Array of supported connection protocols (websocket sub-protocols).
     * @param accessToken Tunnel host access token, or null if anonymous.
     * @param clientConfig Client config for websocket.
     */
    createRelayStream(relayUri: string, protocols: string[], accessToken?: string, clientConfig?: IClientConfig): Promise<{
        stream: Stream;
        protocol: string;
    }>;
}
//# sourceMappingURL=tunnelRelayStreamFactory.d.ts.map