FilesExpand file tree

python-setup

/

readline.d.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

150 lines (132 loc) · 6.46 KB

python-setup

/

readline.d.ts

Copy path

Top

File metadata and controls

• Code
• Blame

150 lines (132 loc) · 6.46 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

declare module "readline" {

import * as events from "events";

import * as stream from "stream";

interface Key {

sequence?: string;

name?: string;

ctrl?: boolean;

meta?: boolean;

shift?: boolean;

}

class Interface extends events.EventEmitter {

readonly terminal: boolean;

/**

* NOTE: According to the documentation:

*

* > Instances of the `readline.Interface` class are constructed using the

* > `readline.createInterface()` method.

*

* @see https://nodejs.org/dist/latest-v10.x/docs/api/readline.html#readline_class_interface

*/

protected constructor(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean);

/**

* NOTE: According to the documentation:

*

* > Instances of the `readline.Interface` class are constructed using the

* > `readline.createInterface()` method.

*

* @see https://nodejs.org/dist/latest-v10.x/docs/api/readline.html#readline_class_interface

*/

protected constructor(options: ReadLineOptions);

setPrompt(prompt: string): void;

prompt(preserveCursor?: boolean): void;

question(query: string, callback: (answer: string) => void): void;

pause(): this;

resume(): this;

close(): void;

write(data: string | Buffer, key?: Key): void;

/**

* events.EventEmitter

* 1. close

* 2. line

* 3. pause

* 4. resume

* 5. SIGCONT

* 6. SIGINT

* 7. SIGTSTP

*/

addListener(event: string, listener: (...args: any[]) => void): this;

addListener(event: "close", listener: () => void): this;

addListener(event: "line", listener: (input: string) => void): this;

addListener(event: "pause", listener: () => void): this;

addListener(event: "resume", listener: () => void): this;

addListener(event: "SIGCONT", listener: () => void): this;

addListener(event: "SIGINT", listener: () => void): this;

addListener(event: "SIGTSTP", listener: () => void): this;

emit(event: string | symbol, ...args: any[]): boolean;

emit(event: "close"): boolean;

emit(event: "line", input: string): boolean;

emit(event: "pause"): boolean;

emit(event: "resume"): boolean;

emit(event: "SIGCONT"): boolean;

emit(event: "SIGINT"): boolean;

emit(event: "SIGTSTP"): boolean;

on(event: string, listener: (...args: any[]) => void): this;

on(event: "close", listener: () => void): this;

on(event: "line", listener: (input: string) => void): this;

on(event: "pause", listener: () => void): this;

on(event: "resume", listener: () => void): this;

on(event: "SIGCONT", listener: () => void): this;

on(event: "SIGINT", listener: () => void): this;

on(event: "SIGTSTP", listener: () => void): this;

once(event: string, listener: (...args: any[]) => void): this;

once(event: "close", listener: () => void): this;

once(event: "line", listener: (input: string) => void): this;

once(event: "pause", listener: () => void): this;

once(event: "resume", listener: () => void): this;

once(event: "SIGCONT", listener: () => void): this;

once(event: "SIGINT", listener: () => void): this;

once(event: "SIGTSTP", listener: () => void): this;

prependListener(event: string, listener: (...args: any[]) => void): this;

prependListener(event: "close", listener: () => void): this;

prependListener(event: "line", listener: (input: string) => void): this;

prependListener(event: "pause", listener: () => void): this;

prependListener(event: "resume", listener: () => void): this;

prependListener(event: "SIGCONT", listener: () => void): this;

prependListener(event: "SIGINT", listener: () => void): this;

prependListener(event: "SIGTSTP", listener: () => void): this;

prependOnceListener(event: string, listener: (...args: any[]) => void): this;

prependOnceListener(event: "close", listener: () => void): this;

prependOnceListener(event: "line", listener: (input: string) => void): this;

prependOnceListener(event: "pause", listener: () => void): this;

prependOnceListener(event: "resume", listener: () => void): this;

prependOnceListener(event: "SIGCONT", listener: () => void): this;

prependOnceListener(event: "SIGINT", listener: () => void): this;

prependOnceListener(event: "SIGTSTP", listener: () => void): this;

[Symbol.asyncIterator](): AsyncIterableIterator<string>;

}

type ReadLine = Interface; // type forwarded for backwards compatiblity

type Completer = (line: string) => CompleterResult;

type AsyncCompleter = (line: string, callback: (err?: null | Error, result?: CompleterResult) => void) => any;

type CompleterResult = [string[], string];

interface ReadLineOptions {

input: NodeJS.ReadableStream;

output?: NodeJS.WritableStream;

completer?: Completer | AsyncCompleter;

terminal?: boolean;

historySize?: number;

prompt?: string;

crlfDelay?: number;

removeHistoryDuplicates?: boolean;

}

function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean): Interface;

function createInterface(options: ReadLineOptions): Interface;

function emitKeypressEvents(stream: NodeJS.ReadableStream, readlineInterface?: Interface): void;

type Direction = -1 | 0 | 1;

/**

* Clears the current line of this WriteStream in a direction identified by `dir`.

*/

function clearLine(stream: NodeJS.WritableStream, dir: Direction, callback?: () => void): boolean;

/**

* Clears this `WriteStream` from the current cursor down.

*/

function clearScreenDown(stream: NodeJS.WritableStream, callback?: () => void): boolean;

/**

* Moves this WriteStream's cursor to the specified position.

*/

function cursorTo(stream: NodeJS.WritableStream, x: number, y?: number, callback?: () => void): boolean;

/**

* Moves this WriteStream's cursor relative to its current position.

*/

function moveCursor(stream: NodeJS.WritableStream, dx: number, dy: number, callback?: () => void): boolean;

}