Interface: NativePtySessionHandle
@termwright/driver/experimental
@termwright/driver/experimental / NativePtySessionHandle
Interface: NativePtySessionHandle
Section titled “Interface: NativePtySessionHandle”Defined in: native-pty-backend.ts:12
Properties
Section titled “Properties”outputEnded
Section titled “outputEnded”
readonlyoutputEnded:Promise<void>
Defined in: native-pty-backend.ts:14
readonlypid:number
Defined in: native-pty-backend.ts:13
sawRealEof
Section titled “sawRealEof”
readonlysawRealEof:boolean
Defined in: native-pty-backend.ts:15
Methods
Section titled “Methods”closeInput()?
Section titled “closeInput()?”
optionalcloseInput():void
Defined in: native-pty-backend.ts:21
Returns
Section titled “Returns”void
dispose()
Section titled “dispose()”dispose():
void
Defined in: native-pty-backend.ts:30
Returns
Section titled “Returns”void
onData()
Section titled “onData()”onData(
listener): () =>void
Defined in: native-pty-backend.ts:26
Parameters
Section titled “Parameters”listener
Section titled “listener”(data) => void
Returns
Section titled “Returns”() => void
onDrain()
Section titled “onDrain()”onDrain(
listener): () =>void
Defined in: native-pty-backend.ts:29
Parameters
Section titled “Parameters”listener
Section titled “listener”() => void
Returns
Section titled “Returns”() => void
onError()
Section titled “onError()”onError(
listener): () =>void
Defined in: native-pty-backend.ts:28
Parameters
Section titled “Parameters”listener
Section titled “listener”(error) => void
Returns
Section titled “Returns”() => void
onExit()
Section titled “onExit()”onExit(
listener): () =>void
Defined in: native-pty-backend.ts:27
Parameters
Section titled “Parameters”listener
Section titled “listener”(status) => void
Returns
Section titled “Returns”() => void
ownedProcessResources()?
Section titled “ownedProcessResources()?”
optionalownedProcessResources():OwnedProcessResourceUsage|null
Defined in: native-pty-backend.ts:25
Returns
Section titled “Returns”OwnedProcessResourceUsage | null
resize()
Section titled “resize()”resize(
columns,rows):boolean
Defined in: native-pty-backend.ts:22
Parameters
Section titled “Parameters”columns
Section titled “columns”number
number
Returns
Section titled “Returns”boolean
signal()
Section titled “signal()”signal(
signal):boolean
Defined in: native-pty-backend.ts:23
Parameters
Section titled “Parameters”signal
Section titled “signal”Returns
Section titled “Returns”boolean
treeState()
Section titled “treeState()”treeState():
"alive"|"gone"|"unsupported"
Defined in: native-pty-backend.ts:24
Returns
Section titled “Returns”"alive" | "gone" | "unsupported"
write()
Section titled “write()”write(
data):void
Defined in: native-pty-backend.ts:16
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”void
writeApplicationInput()?
Section titled “writeApplicationInput()?”
optionalwriteApplicationInput(data,kind):void
Defined in: native-pty-backend.ts:17
Parameters
Section titled “Parameters”Uint8Array
"key" | "mouse" | "paste" | "raw"
Returns
Section titled “Returns”void
writeTerminalResponse()?
Section titled “writeTerminalResponse()?”
optionalwriteTerminalResponse(data):"host-control"|"application-envelope"|"application-direct"
Defined in: native-pty-backend.ts:18
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”"host-control" | "application-envelope" | "application-direct"