Interface StdioInputStream

Implemented by entities from which data can be read.

interface StdioInputStream {
    isTerminal: boolean;
    type: StdioType;
    read(buf: Uint8Array): Promise<number>;
    setRawMode(enable: boolean): void;
}

Hierarchy (view full)

Reader
- StdioInputStream

Index

Properties

isTerminal type

Methods

read setRawMode

Properties

isTerminal

isTerminal: boolean

type

type: StdioType

Methods

read

read(buf): Promise<number>
Reads data into the given buffer. Resolves to the number of read bytes or null for EOF.
Parameters
- buf: Uint8Array
  Buffer to read data into.
Returns Promise<number>
Inherited from Reader.read

setRawMode

setRawMode(enable): void
Parameters
- enable: boolean
Returns void