Skip to content

k.net.telnetClient

Telnet sessions

Overview

k.net.telnetClient.connect establishes a Telnet connection and reads and writes the terminal inside the callback.

connect()

ParameterTypeRequiredDescription
hoststringYesTelnet host name or IP
portnumberYesPort
callback(client) => voidYesSession callback after connecting
timeoutnumberNoTimeout in seconds; default is 30

Returns: void.

ts
k.net.telnetClient.connect(host, port, (client) => {
    client.writeLine("help")
    const text = client.read(10)
}, 30)

ConnectedClient

MethodDescription
write / writeLineSend a command
read(timeout?)Read output
terminatedRead(terminator, timeout?)Read until a terminator is found
MethodParameterReturn
write(command)stringvoid
writeLine(command)stringvoid
read(timeout?)number?string
terminatedRead(terminator, timeout?)string, number?string
ts
k.net.telnetClient.connect("smtp.example.com", 25, client => {
    const hello = client.terminatedRead("\r\n", 10)
    client.writeLine("HELO kooboo.local")
    const response = client.read(10)
    return { hello, response }
})