mcpbrowser 0.2.2 → 0.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (126) hide show
  1. package/README.md +36 -21
  2. package/package.json +2 -3
  3. package/server.json +2 -2
  4. package/src/mcp-browser.js +42 -6
  5. package/.mcpregistry_github_token +0 -1
  6. package/.mcpregistry_registry_token +0 -1
  7. package/extension/mcpbrowser-0.1.1.vsix +0 -0
  8. package/extension/mcpbrowser-0.1.2.vsix +0 -0
  9. package/extension/mcpbrowser-0.1.3.vsix +0 -0
  10. package/extension/mcpbrowser-0.1.4.vsix +0 -0
  11. package/extension/mcpbrowser-config-0.1.0.vsix +0 -0
  12. package/extension/node_modules/.package-lock.json +0 -32
  13. package/extension/node_modules/@types/node/LICENSE +0 -21
  14. package/extension/node_modules/@types/node/README.md +0 -15
  15. package/extension/node_modules/@types/node/assert/strict.d.ts +0 -8
  16. package/extension/node_modules/@types/node/assert.d.ts +0 -1062
  17. package/extension/node_modules/@types/node/async_hooks.d.ts +0 -605
  18. package/extension/node_modules/@types/node/buffer.buffer.d.ts +0 -471
  19. package/extension/node_modules/@types/node/buffer.d.ts +0 -1936
  20. package/extension/node_modules/@types/node/child_process.d.ts +0 -1475
  21. package/extension/node_modules/@types/node/cluster.d.ts +0 -577
  22. package/extension/node_modules/@types/node/compatibility/disposable.d.ts +0 -16
  23. package/extension/node_modules/@types/node/compatibility/index.d.ts +0 -9
  24. package/extension/node_modules/@types/node/compatibility/indexable.d.ts +0 -20
  25. package/extension/node_modules/@types/node/compatibility/iterators.d.ts +0 -21
  26. package/extension/node_modules/@types/node/console.d.ts +0 -452
  27. package/extension/node_modules/@types/node/constants.d.ts +0 -21
  28. package/extension/node_modules/@types/node/crypto.d.ts +0 -4590
  29. package/extension/node_modules/@types/node/dgram.d.ts +0 -597
  30. package/extension/node_modules/@types/node/diagnostics_channel.d.ts +0 -578
  31. package/extension/node_modules/@types/node/dns/promises.d.ts +0 -479
  32. package/extension/node_modules/@types/node/dns.d.ts +0 -871
  33. package/extension/node_modules/@types/node/domain.d.ts +0 -170
  34. package/extension/node_modules/@types/node/events.d.ts +0 -977
  35. package/extension/node_modules/@types/node/fs/promises.d.ts +0 -1270
  36. package/extension/node_modules/@types/node/fs.d.ts +0 -4375
  37. package/extension/node_modules/@types/node/globals.d.ts +0 -172
  38. package/extension/node_modules/@types/node/globals.typedarray.d.ts +0 -38
  39. package/extension/node_modules/@types/node/http.d.ts +0 -2049
  40. package/extension/node_modules/@types/node/http2.d.ts +0 -2631
  41. package/extension/node_modules/@types/node/https.d.ts +0 -578
  42. package/extension/node_modules/@types/node/index.d.ts +0 -93
  43. package/extension/node_modules/@types/node/inspector.generated.d.ts +0 -3966
  44. package/extension/node_modules/@types/node/module.d.ts +0 -539
  45. package/extension/node_modules/@types/node/net.d.ts +0 -1012
  46. package/extension/node_modules/@types/node/os.d.ts +0 -506
  47. package/extension/node_modules/@types/node/package.json +0 -140
  48. package/extension/node_modules/@types/node/path.d.ts +0 -200
  49. package/extension/node_modules/@types/node/perf_hooks.d.ts +0 -961
  50. package/extension/node_modules/@types/node/process.d.ts +0 -1957
  51. package/extension/node_modules/@types/node/punycode.d.ts +0 -117
  52. package/extension/node_modules/@types/node/querystring.d.ts +0 -152
  53. package/extension/node_modules/@types/node/readline/promises.d.ts +0 -162
  54. package/extension/node_modules/@types/node/readline.d.ts +0 -589
  55. package/extension/node_modules/@types/node/repl.d.ts +0 -430
  56. package/extension/node_modules/@types/node/sea.d.ts +0 -153
  57. package/extension/node_modules/@types/node/stream/consumers.d.ts +0 -38
  58. package/extension/node_modules/@types/node/stream/promises.d.ts +0 -90
  59. package/extension/node_modules/@types/node/stream/web.d.ts +0 -533
  60. package/extension/node_modules/@types/node/stream.d.ts +0 -1675
  61. package/extension/node_modules/@types/node/string_decoder.d.ts +0 -67
  62. package/extension/node_modules/@types/node/test.d.ts +0 -1787
  63. package/extension/node_modules/@types/node/timers/promises.d.ts +0 -108
  64. package/extension/node_modules/@types/node/timers.d.ts +0 -286
  65. package/extension/node_modules/@types/node/tls.d.ts +0 -1255
  66. package/extension/node_modules/@types/node/trace_events.d.ts +0 -197
  67. package/extension/node_modules/@types/node/ts5.6/buffer.buffer.d.ts +0 -468
  68. package/extension/node_modules/@types/node/ts5.6/globals.typedarray.d.ts +0 -34
  69. package/extension/node_modules/@types/node/ts5.6/index.d.ts +0 -93
  70. package/extension/node_modules/@types/node/tty.d.ts +0 -208
  71. package/extension/node_modules/@types/node/url.d.ts +0 -964
  72. package/extension/node_modules/@types/node/util.d.ts +0 -2331
  73. package/extension/node_modules/@types/node/v8.d.ts +0 -809
  74. package/extension/node_modules/@types/node/vm.d.ts +0 -1001
  75. package/extension/node_modules/@types/node/wasi.d.ts +0 -181
  76. package/extension/node_modules/@types/node/web-globals/abortcontroller.d.ts +0 -34
  77. package/extension/node_modules/@types/node/web-globals/domexception.d.ts +0 -68
  78. package/extension/node_modules/@types/node/web-globals/events.d.ts +0 -97
  79. package/extension/node_modules/@types/node/web-globals/fetch.d.ts +0 -46
  80. package/extension/node_modules/@types/node/worker_threads.d.ts +0 -715
  81. package/extension/node_modules/@types/node/zlib.d.ts +0 -540
  82. package/extension/node_modules/@types/vscode/LICENSE +0 -21
  83. package/extension/node_modules/@types/vscode/README.md +0 -15
  84. package/extension/node_modules/@types/vscode/index.d.ts +0 -21153
  85. package/extension/node_modules/@types/vscode/package.json +0 -26
  86. package/extension/node_modules/undici-types/LICENSE +0 -21
  87. package/extension/node_modules/undici-types/README.md +0 -6
  88. package/extension/node_modules/undici-types/agent.d.ts +0 -31
  89. package/extension/node_modules/undici-types/api.d.ts +0 -43
  90. package/extension/node_modules/undici-types/balanced-pool.d.ts +0 -29
  91. package/extension/node_modules/undici-types/cache.d.ts +0 -36
  92. package/extension/node_modules/undici-types/client.d.ts +0 -108
  93. package/extension/node_modules/undici-types/connector.d.ts +0 -34
  94. package/extension/node_modules/undici-types/content-type.d.ts +0 -21
  95. package/extension/node_modules/undici-types/cookies.d.ts +0 -28
  96. package/extension/node_modules/undici-types/diagnostics-channel.d.ts +0 -66
  97. package/extension/node_modules/undici-types/dispatcher.d.ts +0 -256
  98. package/extension/node_modules/undici-types/env-http-proxy-agent.d.ts +0 -21
  99. package/extension/node_modules/undici-types/errors.d.ts +0 -149
  100. package/extension/node_modules/undici-types/eventsource.d.ts +0 -61
  101. package/extension/node_modules/undici-types/fetch.d.ts +0 -209
  102. package/extension/node_modules/undici-types/file.d.ts +0 -39
  103. package/extension/node_modules/undici-types/filereader.d.ts +0 -54
  104. package/extension/node_modules/undici-types/formdata.d.ts +0 -108
  105. package/extension/node_modules/undici-types/global-dispatcher.d.ts +0 -9
  106. package/extension/node_modules/undici-types/global-origin.d.ts +0 -7
  107. package/extension/node_modules/undici-types/handlers.d.ts +0 -15
  108. package/extension/node_modules/undici-types/header.d.ts +0 -4
  109. package/extension/node_modules/undici-types/index.d.ts +0 -71
  110. package/extension/node_modules/undici-types/interceptors.d.ts +0 -17
  111. package/extension/node_modules/undici-types/mock-agent.d.ts +0 -50
  112. package/extension/node_modules/undici-types/mock-client.d.ts +0 -25
  113. package/extension/node_modules/undici-types/mock-errors.d.ts +0 -12
  114. package/extension/node_modules/undici-types/mock-interceptor.d.ts +0 -93
  115. package/extension/node_modules/undici-types/mock-pool.d.ts +0 -25
  116. package/extension/node_modules/undici-types/package.json +0 -55
  117. package/extension/node_modules/undici-types/patch.d.ts +0 -33
  118. package/extension/node_modules/undici-types/pool-stats.d.ts +0 -19
  119. package/extension/node_modules/undici-types/pool.d.ts +0 -39
  120. package/extension/node_modules/undici-types/proxy-agent.d.ts +0 -28
  121. package/extension/node_modules/undici-types/readable.d.ts +0 -65
  122. package/extension/node_modules/undici-types/retry-agent.d.ts +0 -8
  123. package/extension/node_modules/undici-types/retry-handler.d.ts +0 -116
  124. package/extension/node_modules/undici-types/util.d.ts +0 -18
  125. package/extension/node_modules/undici-types/webidl.d.ts +0 -228
  126. package/extension/node_modules/undici-types/websocket.d.ts +0 -150
@@ -1,117 +0,0 @@
1
- /**
2
- * **The version of the punycode module bundled in Node.js is being deprecated. **In a future major version of Node.js this module will be removed. Users
3
- * currently depending on the `punycode` module should switch to using the
4
- * userland-provided [Punycode.js](https://github.com/bestiejs/punycode.js) module instead. For punycode-based URL
5
- * encoding, see `url.domainToASCII` or, more generally, the `WHATWG URL API`.
6
- *
7
- * The `punycode` module is a bundled version of the [Punycode.js](https://github.com/bestiejs/punycode.js) module. It
8
- * can be accessed using:
9
- *
10
- * ```js
11
- * import punycode from 'node:punycode';
12
- * ```
13
- *
14
- * [Punycode](https://tools.ietf.org/html/rfc3492) is a character encoding scheme defined by RFC 3492 that is
15
- * primarily intended for use in Internationalized Domain Names. Because host
16
- * names in URLs are limited to ASCII characters only, Domain Names that contain
17
- * non-ASCII characters must be converted into ASCII using the Punycode scheme.
18
- * For instance, the Japanese character that translates into the English word, `'example'` is `'例'`. The Internationalized Domain Name, `'例.com'` (equivalent
19
- * to `'example.com'`) is represented by Punycode as the ASCII string `'xn--fsq.com'`.
20
- *
21
- * The `punycode` module provides a simple implementation of the Punycode standard.
22
- *
23
- * The `punycode` module is a third-party dependency used by Node.js and
24
- * made available to developers as a convenience. Fixes or other modifications to
25
- * the module must be directed to the [Punycode.js](https://github.com/bestiejs/punycode.js) project.
26
- * @deprecated Since v7.0.0 - Deprecated
27
- * @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/punycode.js)
28
- */
29
- declare module "punycode" {
30
- /**
31
- * The `punycode.decode()` method converts a [Punycode](https://tools.ietf.org/html/rfc3492) string of ASCII-only
32
- * characters to the equivalent string of Unicode codepoints.
33
- *
34
- * ```js
35
- * punycode.decode('maana-pta'); // 'mañana'
36
- * punycode.decode('--dqo34k'); // '☃-⌘'
37
- * ```
38
- * @since v0.5.1
39
- */
40
- function decode(string: string): string;
41
- /**
42
- * The `punycode.encode()` method converts a string of Unicode codepoints to a [Punycode](https://tools.ietf.org/html/rfc3492) string of ASCII-only characters.
43
- *
44
- * ```js
45
- * punycode.encode('mañana'); // 'maana-pta'
46
- * punycode.encode('☃-⌘'); // '--dqo34k'
47
- * ```
48
- * @since v0.5.1
49
- */
50
- function encode(string: string): string;
51
- /**
52
- * The `punycode.toUnicode()` method converts a string representing a domain name
53
- * containing [Punycode](https://tools.ietf.org/html/rfc3492) encoded characters into Unicode. Only the [Punycode](https://tools.ietf.org/html/rfc3492) encoded parts of the domain name are be
54
- * converted.
55
- *
56
- * ```js
57
- * // decode domain names
58
- * punycode.toUnicode('xn--maana-pta.com'); // 'mañana.com'
59
- * punycode.toUnicode('xn----dqo34k.com'); // '☃-⌘.com'
60
- * punycode.toUnicode('example.com'); // 'example.com'
61
- * ```
62
- * @since v0.6.1
63
- */
64
- function toUnicode(domain: string): string;
65
- /**
66
- * The `punycode.toASCII()` method converts a Unicode string representing an
67
- * Internationalized Domain Name to [Punycode](https://tools.ietf.org/html/rfc3492). Only the non-ASCII parts of the
68
- * domain name will be converted. Calling `punycode.toASCII()` on a string that
69
- * already only contains ASCII characters will have no effect.
70
- *
71
- * ```js
72
- * // encode domain names
73
- * punycode.toASCII('mañana.com'); // 'xn--maana-pta.com'
74
- * punycode.toASCII('☃-⌘.com'); // 'xn----dqo34k.com'
75
- * punycode.toASCII('example.com'); // 'example.com'
76
- * ```
77
- * @since v0.6.1
78
- */
79
- function toASCII(domain: string): string;
80
- /**
81
- * @deprecated since v7.0.0
82
- * The version of the punycode module bundled in Node.js is being deprecated.
83
- * In a future major version of Node.js this module will be removed.
84
- * Users currently depending on the punycode module should switch to using
85
- * the userland-provided Punycode.js module instead.
86
- */
87
- const ucs2: ucs2;
88
- interface ucs2 {
89
- /**
90
- * @deprecated since v7.0.0
91
- * The version of the punycode module bundled in Node.js is being deprecated.
92
- * In a future major version of Node.js this module will be removed.
93
- * Users currently depending on the punycode module should switch to using
94
- * the userland-provided Punycode.js module instead.
95
- */
96
- decode(string: string): number[];
97
- /**
98
- * @deprecated since v7.0.0
99
- * The version of the punycode module bundled in Node.js is being deprecated.
100
- * In a future major version of Node.js this module will be removed.
101
- * Users currently depending on the punycode module should switch to using
102
- * the userland-provided Punycode.js module instead.
103
- */
104
- encode(codePoints: readonly number[]): string;
105
- }
106
- /**
107
- * @deprecated since v7.0.0
108
- * The version of the punycode module bundled in Node.js is being deprecated.
109
- * In a future major version of Node.js this module will be removed.
110
- * Users currently depending on the punycode module should switch to using
111
- * the userland-provided Punycode.js module instead.
112
- */
113
- const version: string;
114
- }
115
- declare module "node:punycode" {
116
- export * from "punycode";
117
- }
@@ -1,152 +0,0 @@
1
- /**
2
- * The `node:querystring` module provides utilities for parsing and formatting URL
3
- * query strings. It can be accessed using:
4
- *
5
- * ```js
6
- * import querystring from 'node:querystring';
7
- * ```
8
- *
9
- * `querystring` is more performant than `URLSearchParams` but is not a
10
- * standardized API. Use `URLSearchParams` when performance is not critical or
11
- * when compatibility with browser code is desirable.
12
- * @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/querystring.js)
13
- */
14
- declare module "querystring" {
15
- interface StringifyOptions {
16
- /**
17
- * The function to use when converting URL-unsafe characters to percent-encoding in the query string.
18
- * @default `querystring.escape()`
19
- */
20
- encodeURIComponent?: ((str: string) => string) | undefined;
21
- }
22
- interface ParseOptions {
23
- /**
24
- * Specifies the maximum number of keys to parse. Specify `0` to remove key counting limitations.
25
- * @default 1000
26
- */
27
- maxKeys?: number | undefined;
28
- /**
29
- * The function to use when decoding percent-encoded characters in the query string.
30
- * @default `querystring.unescape()`
31
- */
32
- decodeURIComponent?: ((str: string) => string) | undefined;
33
- }
34
- interface ParsedUrlQuery extends NodeJS.Dict<string | string[]> {}
35
- interface ParsedUrlQueryInput extends
36
- NodeJS.Dict<
37
- | string
38
- | number
39
- | boolean
40
- | bigint
41
- | ReadonlyArray<string | number | boolean | bigint>
42
- | null
43
- >
44
- {}
45
- /**
46
- * The `querystring.stringify()` method produces a URL query string from a
47
- * given `obj` by iterating through the object's "own properties".
48
- *
49
- * It serializes the following types of values passed in `obj`: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) |
50
- * [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) |
51
- * [bigint](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) |
52
- * [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) |
53
- * [string\[\]](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) |
54
- * [number\[\]](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) |
55
- * [bigint\[\]](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) |
56
- * [boolean\[\]](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) The numeric values must be finite. Any other input values will be coerced to
57
- * empty strings.
58
- *
59
- * ```js
60
- * querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' });
61
- * // Returns 'foo=bar&#x26;baz=qux&#x26;baz=quux&#x26;corge='
62
- *
63
- * querystring.stringify({ foo: 'bar', baz: 'qux' }, ';', ':');
64
- * // Returns 'foo:bar;baz:qux'
65
- * ```
66
- *
67
- * By default, characters requiring percent-encoding within the query string will
68
- * be encoded as UTF-8\. If an alternative encoding is required, then an alternative `encodeURIComponent` option will need to be specified:
69
- *
70
- * ```js
71
- * // Assuming gbkEncodeURIComponent function already exists,
72
- *
73
- * querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
74
- * { encodeURIComponent: gbkEncodeURIComponent });
75
- * ```
76
- * @since v0.1.25
77
- * @param obj The object to serialize into a URL query string
78
- * @param [sep='&'] The substring used to delimit key and value pairs in the query string.
79
- * @param [eq='='] . The substring used to delimit keys and values in the query string.
80
- */
81
- function stringify(obj?: ParsedUrlQueryInput, sep?: string, eq?: string, options?: StringifyOptions): string;
82
- /**
83
- * The `querystring.parse()` method parses a URL query string (`str`) into a
84
- * collection of key and value pairs.
85
- *
86
- * For example, the query string `'foo=bar&#x26;abc=xyz&#x26;abc=123'` is parsed into:
87
- *
88
- * ```json
89
- * {
90
- * "foo": "bar",
91
- * "abc": ["xyz", "123"]
92
- * }
93
- * ```
94
- *
95
- * The object returned by the `querystring.parse()` method _does not_ prototypically inherit from the JavaScript `Object`. This means that typical `Object` methods such as `obj.toString()`,
96
- * `obj.hasOwnProperty()`, and others
97
- * are not defined and _will not work_.
98
- *
99
- * By default, percent-encoded characters within the query string will be assumed
100
- * to use UTF-8 encoding. If an alternative character encoding is used, then an
101
- * alternative `decodeURIComponent` option will need to be specified:
102
- *
103
- * ```js
104
- * // Assuming gbkDecodeURIComponent function already exists...
105
- *
106
- * querystring.parse('w=%D6%D0%CE%C4&#x26;foo=bar', null, null,
107
- * { decodeURIComponent: gbkDecodeURIComponent });
108
- * ```
109
- * @since v0.1.25
110
- * @param str The URL query string to parse
111
- * @param [sep='&'] The substring used to delimit key and value pairs in the query string.
112
- * @param [eq='='] The substring used to delimit keys and values in the query string.
113
- */
114
- function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): ParsedUrlQuery;
115
- /**
116
- * The querystring.encode() function is an alias for querystring.stringify().
117
- */
118
- const encode: typeof stringify;
119
- /**
120
- * The querystring.decode() function is an alias for querystring.parse().
121
- */
122
- const decode: typeof parse;
123
- /**
124
- * The `querystring.escape()` method performs URL percent-encoding on the given `str` in a manner that is optimized for the specific requirements of URL
125
- * query strings.
126
- *
127
- * The `querystring.escape()` method is used by `querystring.stringify()` and is
128
- * generally not expected to be used directly. It is exported primarily to allow
129
- * application code to provide a replacement percent-encoding implementation if
130
- * necessary by assigning `querystring.escape` to an alternative function.
131
- * @since v0.1.25
132
- */
133
- function escape(str: string): string;
134
- /**
135
- * The `querystring.unescape()` method performs decoding of URL percent-encoded
136
- * characters on the given `str`.
137
- *
138
- * The `querystring.unescape()` method is used by `querystring.parse()` and is
139
- * generally not expected to be used directly. It is exported primarily to allow
140
- * application code to provide a replacement decoding implementation if
141
- * necessary by assigning `querystring.unescape` to an alternative function.
142
- *
143
- * By default, the `querystring.unescape()` method will attempt to use the
144
- * JavaScript built-in `decodeURIComponent()` method to decode. If that fails,
145
- * a safer equivalent that does not throw on malformed URLs will be used.
146
- * @since v0.1.25
147
- */
148
- function unescape(str: string): string;
149
- }
150
- declare module "node:querystring" {
151
- export * from "querystring";
152
- }
@@ -1,162 +0,0 @@
1
- /**
2
- * @since v17.0.0
3
- * @experimental
4
- */
5
- declare module "readline/promises" {
6
- import { Abortable } from "node:events";
7
- import {
8
- CompleterResult,
9
- Direction,
10
- Interface as _Interface,
11
- ReadLineOptions as _ReadLineOptions,
12
- } from "node:readline";
13
- /**
14
- * Instances of the `readlinePromises.Interface` class are constructed using the `readlinePromises.createInterface()` method. Every instance is associated with a
15
- * single `input` `Readable` stream and a single `output` `Writable` stream.
16
- * The `output` stream is used to print prompts for user input that arrives on,
17
- * and is read from, the `input` stream.
18
- * @since v17.0.0
19
- */
20
- class Interface extends _Interface {
21
- /**
22
- * The `rl.question()` method displays the `query` by writing it to the `output`,
23
- * waits for user input to be provided on `input`, then invokes the `callback` function passing the provided input as the first argument.
24
- *
25
- * When called, `rl.question()` will resume the `input` stream if it has been
26
- * paused.
27
- *
28
- * If the `Interface` was created with `output` set to `null` or `undefined` the `query` is not written.
29
- *
30
- * If the question is called after `rl.close()`, it returns a rejected promise.
31
- *
32
- * Example usage:
33
- *
34
- * ```js
35
- * const answer = await rl.question('What is your favorite food? ');
36
- * console.log(`Oh, so your favorite food is ${answer}`);
37
- * ```
38
- *
39
- * Using an `AbortSignal` to cancel a question.
40
- *
41
- * ```js
42
- * const signal = AbortSignal.timeout(10_000);
43
- *
44
- * signal.addEventListener('abort', () => {
45
- * console.log('The food question timed out');
46
- * }, { once: true });
47
- *
48
- * const answer = await rl.question('What is your favorite food? ', { signal });
49
- * console.log(`Oh, so your favorite food is ${answer}`);
50
- * ```
51
- * @since v17.0.0
52
- * @param query A statement or query to write to `output`, prepended to the prompt.
53
- * @return A promise that is fulfilled with the user's input in response to the `query`.
54
- */
55
- question(query: string): Promise<string>;
56
- question(query: string, options: Abortable): Promise<string>;
57
- }
58
- /**
59
- * @since v17.0.0
60
- */
61
- class Readline {
62
- /**
63
- * @param stream A TTY stream.
64
- */
65
- constructor(
66
- stream: NodeJS.WritableStream,
67
- options?: {
68
- autoCommit?: boolean | undefined;
69
- },
70
- );
71
- /**
72
- * The `rl.clearLine()` method adds to the internal list of pending action an
73
- * action that clears current line of the associated `stream` in a specified
74
- * direction identified by `dir`.
75
- * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
76
- * @since v17.0.0
77
- * @return this
78
- */
79
- clearLine(dir: Direction): this;
80
- /**
81
- * The `rl.clearScreenDown()` method adds to the internal list of pending action an
82
- * action that clears the associated stream from the current position of the
83
- * cursor down.
84
- * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
85
- * @since v17.0.0
86
- * @return this
87
- */
88
- clearScreenDown(): this;
89
- /**
90
- * The `rl.commit()` method sends all the pending actions to the associated `stream` and clears the internal list of pending actions.
91
- * @since v17.0.0
92
- */
93
- commit(): Promise<void>;
94
- /**
95
- * The `rl.cursorTo()` method adds to the internal list of pending action an action
96
- * that moves cursor to the specified position in the associated `stream`.
97
- * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
98
- * @since v17.0.0
99
- * @return this
100
- */
101
- cursorTo(x: number, y?: number): this;
102
- /**
103
- * The `rl.moveCursor()` method adds to the internal list of pending action an
104
- * action that moves the cursor _relative_ to its current position in the
105
- * associated `stream`.
106
- * Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
107
- * @since v17.0.0
108
- * @return this
109
- */
110
- moveCursor(dx: number, dy: number): this;
111
- /**
112
- * The `rl.rollback` methods clears the internal list of pending actions without
113
- * sending it to the associated `stream`.
114
- * @since v17.0.0
115
- * @return this
116
- */
117
- rollback(): this;
118
- }
119
- type Completer = (line: string) => CompleterResult | Promise<CompleterResult>;
120
- interface ReadLineOptions extends Omit<_ReadLineOptions, "completer"> {
121
- /**
122
- * An optional function used for Tab autocompletion.
123
- */
124
- completer?: Completer | undefined;
125
- }
126
- /**
127
- * The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface` instance.
128
- *
129
- * ```js
130
- * import readlinePromises from 'node:readline/promises';
131
- * const rl = readlinePromises.createInterface({
132
- * input: process.stdin,
133
- * output: process.stdout,
134
- * });
135
- * ```
136
- *
137
- * Once the `readlinePromises.Interface` instance is created, the most common case
138
- * is to listen for the `'line'` event:
139
- *
140
- * ```js
141
- * rl.on('line', (line) => {
142
- * console.log(`Received: ${line}`);
143
- * });
144
- * ```
145
- *
146
- * If `terminal` is `true` for this instance then the `output` stream will get
147
- * the best compatibility if it defines an `output.columns` property and emits
148
- * a `'resize'` event on the `output` if or when the columns ever change
149
- * (`process.stdout` does this automatically when it is a TTY).
150
- * @since v17.0.0
151
- */
152
- function createInterface(
153
- input: NodeJS.ReadableStream,
154
- output?: NodeJS.WritableStream,
155
- completer?: Completer,
156
- terminal?: boolean,
157
- ): Interface;
158
- function createInterface(options: ReadLineOptions): Interface;
159
- }
160
- declare module "node:readline/promises" {
161
- export * from "readline/promises";
162
- }