Module "readline"

Index

Classes

Interface

Interfaces

Type aliases

Functions

Type aliases

AsyncCompleter

AsyncCompleter: function

Type declaration

- (line: string, callback: function): any
- Parameters
  - line: string
  - callback: function
    - - (err?: null | Error, result?: CompleterResult): void
      - Parameters
        
        Optional err: null | Error
        
        Optional result: CompleterResult
        
        Returns void
  Returns any

Completer

Completer: function

Type declaration

- (line: string): CompleterResult
- Parameters
  - line: string
  Returns CompleterResult

CompleterResult

CompleterResult: [string[], string]

Direction

Direction: -1 | 0 | 1

ReadLine

ReadLine: Interface

Functions

clearLine

clearLine(stream: WritableStream, dir: Direction, callback?: function): boolean

- Defined in node_modules/@types/node/readline.d.ts:161
Clears the current line of this WriteStream in a direction identified by dir.

Parameters
- stream: WritableStream
- dir: Direction
- Optional callback: function
  - - (): void
    - Returns void
Returns boolean

clearScreenDown

clearScreenDown(stream: WritableStream, callback?: function): boolean

- Defined in node_modules/@types/node/readline.d.ts:165
Clears this WriteStream from the current cursor down.

Parameters
- stream: WritableStream
- Optional callback: function
  - - (): void
    - Returns void
Returns boolean

createInterface

createInterface(input: ReadableStream, output?: WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean): Interface
createInterface(options: ReadLineOptions): Interface

- Defined in node_modules/@types/node/readline.d.ts:147
Parameters
- input: ReadableStream
- Optional output: WritableStream
- Optional completer: Completer | AsyncCompleter
- Optional terminal: boolean
Returns Interface
- Defined in node_modules/@types/node/readline.d.ts:148
Parameters
- options: ReadLineOptions
Returns Interface

cursorTo

cursorTo(stream: WritableStream, x: number, y?: number, callback?: function): boolean

- Defined in node_modules/@types/node/readline.d.ts:169
Moves this WriteStream's cursor to the specified position.

Parameters
- stream: WritableStream
- x: number
- Optional y: number
- Optional callback: function
  - - (): void
    - Returns void
Returns boolean

emitKeypressEvents

emitKeypressEvents(stream: ReadableStream, readlineInterface?: Interface): void

- Defined in node_modules/@types/node/readline.d.ts:149
Parameters
- stream: ReadableStream
- Optional readlineInterface: Interface
Returns void

moveCursor

moveCursor(stream: WritableStream, dx: number, dy: number, callback?: function): boolean

- Defined in node_modules/@types/node/readline.d.ts:173
Moves this WriteStream's cursor relative to its current position.

Parameters
- stream: WritableStream
- dx: number
- dy: number
- Optional callback: function
  - - (): void
    - Returns void
Returns boolean

Generated using TypeDoc