edgeport - v1.0.6
    Preparing search index...

    Interface SshChannelHandle

    A live duplex channel (interactive shell or subsystem).

    interface SshChannelHandle {
        exit: Promise<ChannelExit>;
        stderr: ReadableStream<Uint8Array<ArrayBufferLike>>;
        stdout: ReadableStream<Uint8Array<ArrayBufferLike>>;
        "[asyncDispose]"(): PromiseLike<void>;
        close(): Promise<void>;
        eof(): Promise<void>;
        write(data: string | Uint8Array<ArrayBufferLike>): Promise<void>;
    }

    Hierarchy

    • AsyncDisposable
      • SshChannelHandle
    Index
    exit stderr stdout
    [asyncDispose] close eof write
    exit: Promise<ChannelExit>
    stderr: ReadableStream<Uint8Array<ArrayBufferLike>>
    stdout: ReadableStream<Uint8Array<ArrayBufferLike>>

    • Returns PromiseLike<void>

    • Writes to the channel's stdin. A string is UTF-8 encoded, so callers do not build a TextEncoder; pass a Uint8Array for binary input.

      Parameters

      • data: string | Uint8Array<ArrayBufferLike>

        The stdin data (string or bytes).

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods