Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/kubernetes_apis/tunnels.ts>StdioTunnel

REST focused Typescript classes for Kubernetes APIs, and tools for generating API interfaces
Latest
class StdioTunnel
import { StdioTunnel } from "https://deno.land/x/kubernetes_apis@v0.5.1/tunnels.ts";

Constructors

new
StdioTunnel(tunnel: KubernetesTunnel, originalParams: URLSearchParams)

Properties

readonly
channelVersion: number
ready: Promise<void>
status: Promise<ExecStatus>
readonly
stderr: ReadableStream<Uint8Array>
readonly
stdin: WritableStream<Uint8Array>
readonly
stdout: ReadableStream<Uint8Array>
readonly
ttyResizeStream: WritableStream<TerminalSize>

If tty was requested, an outbound stream for dynamically changing the TTY dimensions

Methods

kill(): void

Immediately disconnects the network tunnel, likely dropping any in-flight data.

output(): Promise<ExecStatus & { stdout: Uint8Array; stderr: Uint8Array; }>

Buffers all data for stdout and/or stderr and returns the buffers when the remote command exits.

ttySetSize(size: TerminalSize): Promise<void>

Shorthand for writing to the tty resize stream, especially useful for setting an initial size

ttyWriteSignal(signal: "INTR" | "QUIT" | "SUSP"): Promise<void>

Shorthand for injecting Ctrl-C and others when running an interactive TTY

Static Properties

readonly
supportedProtocols: string[]