cloudstructs 0.6.2 → 0.6.3
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.
- package/.jsii +3 -3
- package/lib/codecommit-mirror/index.js +2 -2
- package/lib/ecs-service-roller/index.js +2 -2
- package/lib/email-receiver/receiver.js +1 -1
- package/lib/saml-identity-provider/index.js +2 -2
- package/lib/slack-app/manifest.js +1 -1
- package/lib/slack-app/slack-app.js +2 -2
- package/lib/slack-events/index.js +1 -1
- package/lib/slack-textract/index.js +1 -1
- package/lib/state-machine-cr-provider/index.js +1 -1
- package/lib/static-website/index.js +1 -1
- package/lib/toolkit-cleaner/index.js +1 -1
- package/lib/url-shortener/index.js +1 -1
- package/node_modules/@slack/logger/node_modules/@types/node/README.md +1 -1
- package/node_modules/@slack/logger/node_modules/@types/node/index.d.ts +1 -0
- package/node_modules/@slack/logger/node_modules/@types/node/package.json +2 -2
- package/node_modules/@slack/logger/node_modules/@types/node/perf_hooks.d.ts +29 -0
- package/node_modules/@slack/logger/node_modules/@types/node/readline/promises.d.ts +143 -0
- package/node_modules/@slack/logger/node_modules/@types/node/readline.d.ts +19 -16
- package/node_modules/@slack/web-api/node_modules/@types/node/README.md +1 -1
- package/node_modules/@slack/web-api/node_modules/@types/node/index.d.ts +1 -0
- package/node_modules/@slack/web-api/node_modules/@types/node/package.json +2 -2
- package/node_modules/@slack/web-api/node_modules/@types/node/perf_hooks.d.ts +29 -0
- package/node_modules/@slack/web-api/node_modules/@types/node/readline/promises.d.ts +143 -0
- package/node_modules/@slack/web-api/node_modules/@types/node/readline.d.ts +19 -16
- package/node_modules/@types/cacheable-request/node_modules/@types/node/README.md +1 -1
- package/node_modules/@types/cacheable-request/node_modules/@types/node/index.d.ts +1 -0
- package/node_modules/@types/cacheable-request/node_modules/@types/node/package.json +2 -2
- package/node_modules/@types/cacheable-request/node_modules/@types/node/perf_hooks.d.ts +29 -0
- package/node_modules/@types/cacheable-request/node_modules/@types/node/readline/promises.d.ts +143 -0
- package/node_modules/@types/cacheable-request/node_modules/@types/node/readline.d.ts +19 -16
- package/node_modules/@types/is-stream/node_modules/@types/node/README.md +1 -1
- package/node_modules/@types/is-stream/node_modules/@types/node/index.d.ts +1 -0
- package/node_modules/@types/is-stream/node_modules/@types/node/package.json +2 -2
- package/node_modules/@types/is-stream/node_modules/@types/node/perf_hooks.d.ts +29 -0
- package/node_modules/@types/is-stream/node_modules/@types/node/readline/promises.d.ts +143 -0
- package/node_modules/@types/is-stream/node_modules/@types/node/readline.d.ts +19 -16
- package/node_modules/@types/keyv/node_modules/@types/node/README.md +1 -1
- package/node_modules/@types/keyv/node_modules/@types/node/index.d.ts +1 -0
- package/node_modules/@types/keyv/node_modules/@types/node/package.json +2 -2
- package/node_modules/@types/keyv/node_modules/@types/node/perf_hooks.d.ts +29 -0
- package/node_modules/@types/keyv/node_modules/@types/node/readline/promises.d.ts +143 -0
- package/node_modules/@types/keyv/node_modules/@types/node/readline.d.ts +19 -16
- package/node_modules/@types/responselike/node_modules/@types/node/README.md +1 -1
- package/node_modules/@types/responselike/node_modules/@types/node/index.d.ts +1 -0
- package/node_modules/@types/responselike/node_modules/@types/node/package.json +2 -2
- package/node_modules/@types/responselike/node_modules/@types/node/perf_hooks.d.ts +29 -0
- package/node_modules/@types/responselike/node_modules/@types/node/readline/promises.d.ts +143 -0
- package/node_modules/@types/responselike/node_modules/@types/node/readline.d.ts +19 -16
- package/package.json +7 -7
|
@@ -34,7 +34,10 @@
|
|
|
34
34
|
*/
|
|
35
35
|
declare module 'readline' {
|
|
36
36
|
import { Abortable, EventEmitter } from 'node:events';
|
|
37
|
-
|
|
37
|
+
import * as promises from 'node:readline/promises';
|
|
38
|
+
|
|
39
|
+
export { promises };
|
|
40
|
+
export interface Key {
|
|
38
41
|
sequence?: string | undefined;
|
|
39
42
|
name?: string | undefined;
|
|
40
43
|
ctrl?: boolean | undefined;
|
|
@@ -48,7 +51,7 @@ declare module 'readline' {
|
|
|
48
51
|
* and is read from, the `input` stream.
|
|
49
52
|
* @since v0.1.104
|
|
50
53
|
*/
|
|
51
|
-
class Interface extends EventEmitter {
|
|
54
|
+
export class Interface extends EventEmitter {
|
|
52
55
|
readonly terminal: boolean;
|
|
53
56
|
/**
|
|
54
57
|
* The current input data being processed by node.
|
|
@@ -315,11 +318,11 @@ declare module 'readline' {
|
|
|
315
318
|
prependOnceListener(event: 'history', listener: (history: string[]) => void): this;
|
|
316
319
|
[Symbol.asyncIterator](): AsyncIterableIterator<string>;
|
|
317
320
|
}
|
|
318
|
-
type ReadLine = Interface; // type forwarded for backwards compatibility
|
|
319
|
-
type Completer = (line: string) => CompleterResult;
|
|
320
|
-
type AsyncCompleter = (line: string, callback: (err?: null | Error, result?: CompleterResult) => void) => void;
|
|
321
|
-
type CompleterResult = [string[], string];
|
|
322
|
-
interface ReadLineOptions {
|
|
321
|
+
export type ReadLine = Interface; // type forwarded for backwards compatibility
|
|
322
|
+
export type Completer = (line: string) => CompleterResult;
|
|
323
|
+
export type AsyncCompleter = (line: string, callback: (err?: null | Error, result?: CompleterResult) => void) => void;
|
|
324
|
+
export type CompleterResult = [string[], string];
|
|
325
|
+
export interface ReadLineOptions {
|
|
323
326
|
input: NodeJS.ReadableStream;
|
|
324
327
|
output?: NodeJS.WritableStream | undefined;
|
|
325
328
|
completer?: Completer | AsyncCompleter | undefined;
|
|
@@ -380,8 +383,8 @@ declare module 'readline' {
|
|
|
380
383
|
* ```
|
|
381
384
|
* @since v0.1.98
|
|
382
385
|
*/
|
|
383
|
-
function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean): Interface;
|
|
384
|
-
function createInterface(options: ReadLineOptions): Interface;
|
|
386
|
+
export function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean): Interface;
|
|
387
|
+
export function createInterface(options: ReadLineOptions): Interface;
|
|
385
388
|
/**
|
|
386
389
|
* The `readline.emitKeypressEvents()` method causes the given `Readable` stream to begin emitting `'keypress'` events corresponding to received input.
|
|
387
390
|
*
|
|
@@ -503,9 +506,9 @@ declare module 'readline' {
|
|
|
503
506
|
* ```
|
|
504
507
|
* @since v0.7.7
|
|
505
508
|
*/
|
|
506
|
-
function emitKeypressEvents(stream: NodeJS.ReadableStream, readlineInterface?: Interface): void;
|
|
507
|
-
type Direction = -1 | 0 | 1;
|
|
508
|
-
interface CursorPos {
|
|
509
|
+
export function emitKeypressEvents(stream: NodeJS.ReadableStream, readlineInterface?: Interface): void;
|
|
510
|
+
export type Direction = -1 | 0 | 1;
|
|
511
|
+
export interface CursorPos {
|
|
509
512
|
rows: number;
|
|
510
513
|
cols: number;
|
|
511
514
|
}
|
|
@@ -516,7 +519,7 @@ declare module 'readline' {
|
|
|
516
519
|
* @param callback Invoked once the operation completes.
|
|
517
520
|
* @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
|
|
518
521
|
*/
|
|
519
|
-
function clearLine(stream: NodeJS.WritableStream, dir: Direction, callback?: () => void): boolean;
|
|
522
|
+
export function clearLine(stream: NodeJS.WritableStream, dir: Direction, callback?: () => void): boolean;
|
|
520
523
|
/**
|
|
521
524
|
* The `readline.clearScreenDown()` method clears the given `TTY` stream from
|
|
522
525
|
* the current position of the cursor down.
|
|
@@ -524,7 +527,7 @@ declare module 'readline' {
|
|
|
524
527
|
* @param callback Invoked once the operation completes.
|
|
525
528
|
* @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
|
|
526
529
|
*/
|
|
527
|
-
function clearScreenDown(stream: NodeJS.WritableStream, callback?: () => void): boolean;
|
|
530
|
+
export function clearScreenDown(stream: NodeJS.WritableStream, callback?: () => void): boolean;
|
|
528
531
|
/**
|
|
529
532
|
* The `readline.cursorTo()` method moves cursor to the specified position in a
|
|
530
533
|
* given `TTY` `stream`.
|
|
@@ -532,7 +535,7 @@ declare module 'readline' {
|
|
|
532
535
|
* @param callback Invoked once the operation completes.
|
|
533
536
|
* @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
|
|
534
537
|
*/
|
|
535
|
-
function cursorTo(stream: NodeJS.WritableStream, x: number, y?: number, callback?: () => void): boolean;
|
|
538
|
+
export function cursorTo(stream: NodeJS.WritableStream, x: number, y?: number, callback?: () => void): boolean;
|
|
536
539
|
/**
|
|
537
540
|
* The `readline.moveCursor()` method moves the cursor _relative_ to its current
|
|
538
541
|
* position in a given `TTY` `stream`.
|
|
@@ -643,7 +646,7 @@ declare module 'readline' {
|
|
|
643
646
|
* @param callback Invoked once the operation completes.
|
|
644
647
|
* @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
|
|
645
648
|
*/
|
|
646
|
-
function moveCursor(stream: NodeJS.WritableStream, dx: number, dy: number, callback?: () => void): boolean;
|
|
649
|
+
export function moveCursor(stream: NodeJS.WritableStream, dx: number, dy: number, callback?: () => void): boolean;
|
|
647
650
|
}
|
|
648
651
|
declare module 'node:readline' {
|
|
649
652
|
export * from 'readline';
|
|
@@ -8,7 +8,7 @@ This package contains type definitions for Node.js (https://nodejs.org/).
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Sat, 13 Aug 2022 13:02:04 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `AbortController`, `AbortSignal`, `__dirname`, `__filename`, `console`, `exports`, `gc`, `global`, `module`, `process`, `require`, `structuredClone`
|
|
14
14
|
|
|
@@ -108,6 +108,7 @@
|
|
|
108
108
|
/// <reference path="punycode.d.ts" />
|
|
109
109
|
/// <reference path="querystring.d.ts" />
|
|
110
110
|
/// <reference path="readline.d.ts" />
|
|
111
|
+
/// <reference path="readline/promises.d.ts" />
|
|
111
112
|
/// <reference path="repl.d.ts" />
|
|
112
113
|
/// <reference path="stream.d.ts" />
|
|
113
114
|
/// <reference path="stream/promises.d.ts" />
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/node",
|
|
3
|
-
"version": "18.7.
|
|
3
|
+
"version": "18.7.3",
|
|
4
4
|
"description": "TypeScript definitions for Node.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
|
|
6
6
|
"license": "MIT",
|
|
@@ -220,6 +220,6 @@
|
|
|
220
220
|
},
|
|
221
221
|
"scripts": {},
|
|
222
222
|
"dependencies": {},
|
|
223
|
-
"typesPublisherContentHash": "
|
|
223
|
+
"typesPublisherContentHash": "8dea3d15b6bef937e990a6b11572d052d6b749766317804596d909c7e26211e5",
|
|
224
224
|
"typeScriptVersion": "4.0"
|
|
225
225
|
}
|
|
@@ -191,6 +191,35 @@ declare module 'perf_hooks' {
|
|
|
191
191
|
* @param name
|
|
192
192
|
*/
|
|
193
193
|
clearMarks(name?: string): void;
|
|
194
|
+
/**
|
|
195
|
+
* If name is not provided, removes all PerformanceMeasure objects from the Performance Timeline.
|
|
196
|
+
* If name is provided, removes only the named measure.
|
|
197
|
+
* @param name
|
|
198
|
+
* @since v16.7.0
|
|
199
|
+
*/
|
|
200
|
+
clearMeasures(name?: string): void;
|
|
201
|
+
/**
|
|
202
|
+
* Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`.
|
|
203
|
+
* If you are only interested in performance entries of certain types or that have certain names, see
|
|
204
|
+
* `performance.getEntriesByType()` and `performance.getEntriesByName()`.
|
|
205
|
+
* @since v16.7.0
|
|
206
|
+
*/
|
|
207
|
+
getEntries(): PerformanceEntry[];
|
|
208
|
+
/**
|
|
209
|
+
* Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`
|
|
210
|
+
* whose `performanceEntry.name` is equal to `name`, and optionally, whose `performanceEntry.entryType` is equal to `type`.
|
|
211
|
+
* @param name
|
|
212
|
+
* @param type
|
|
213
|
+
* @since v16.7.0
|
|
214
|
+
*/
|
|
215
|
+
getEntriesByName(name: string, type?: EntryType): PerformanceEntry[];
|
|
216
|
+
/**
|
|
217
|
+
* Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`
|
|
218
|
+
* whose `performanceEntry.entryType` is equal to `type`.
|
|
219
|
+
* @param type
|
|
220
|
+
* @since v16.7.0
|
|
221
|
+
*/
|
|
222
|
+
getEntriesByType(type: EntryType): PerformanceEntry[];
|
|
194
223
|
/**
|
|
195
224
|
* Creates a new PerformanceMark entry in the Performance Timeline.
|
|
196
225
|
* A PerformanceMark is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'mark',
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The `readline/promise` module provides an API for reading lines of input from a Readable stream one line at a time.
|
|
3
|
+
*
|
|
4
|
+
* @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/readline/promises.js)
|
|
5
|
+
* @since v17.0.0
|
|
6
|
+
*/
|
|
7
|
+
declare module 'readline/promises' {
|
|
8
|
+
import { Interface as _Interface, ReadLineOptions, Completer, AsyncCompleter, Direction } from 'node:readline';
|
|
9
|
+
import { Abortable } from 'node:events';
|
|
10
|
+
|
|
11
|
+
class Interface extends _Interface {
|
|
12
|
+
/**
|
|
13
|
+
* The rl.question() method displays the query by writing it to the output, waits for user input to be provided on input,
|
|
14
|
+
* then invokes the callback function passing the provided input as the first argument.
|
|
15
|
+
*
|
|
16
|
+
* When called, rl.question() will resume the input stream if it has been paused.
|
|
17
|
+
*
|
|
18
|
+
* If the readlinePromises.Interface was created with output set to null or undefined the query is not written.
|
|
19
|
+
*
|
|
20
|
+
* If the question is called after rl.close(), it returns a rejected promise.
|
|
21
|
+
*
|
|
22
|
+
* Example usage:
|
|
23
|
+
*
|
|
24
|
+
* ```js
|
|
25
|
+
* const answer = await rl.question('What is your favorite food? ');
|
|
26
|
+
* console.log(`Oh, so your favorite food is ${answer}`);
|
|
27
|
+
* ```
|
|
28
|
+
*
|
|
29
|
+
* Using an AbortSignal to cancel a question.
|
|
30
|
+
*
|
|
31
|
+
* ```js
|
|
32
|
+
* const signal = AbortSignal.timeout(10_000);
|
|
33
|
+
*
|
|
34
|
+
* signal.addEventListener('abort', () => {
|
|
35
|
+
* console.log('The food question timed out');
|
|
36
|
+
* }, { once: true });
|
|
37
|
+
*
|
|
38
|
+
* const answer = await rl.question('What is your favorite food? ', { signal });
|
|
39
|
+
* console.log(`Oh, so your favorite food is ${answer}`);
|
|
40
|
+
* ```
|
|
41
|
+
*
|
|
42
|
+
* @since v17.0.0
|
|
43
|
+
* @param query A statement or query to write to output, prepended to the prompt.
|
|
44
|
+
*/
|
|
45
|
+
question(query: string): Promise<string>;
|
|
46
|
+
question(query: string, options: Abortable): Promise<string>;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
class Readline {
|
|
50
|
+
/**
|
|
51
|
+
* @param stream A TTY stream.
|
|
52
|
+
*/
|
|
53
|
+
constructor(stream: NodeJS.WritableStream, options?: { autoCommit?: boolean });
|
|
54
|
+
/**
|
|
55
|
+
* The `rl.clearLine()` method adds to the internal list of pending action an action that clears current line of the associated `stream` in a specified direction identified by `dir`.
|
|
56
|
+
* Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
|
|
57
|
+
*/
|
|
58
|
+
clearLine(dir: Direction): this;
|
|
59
|
+
/**
|
|
60
|
+
* The `rl.clearScreenDown()` method adds to the internal list of pending action an action that clears the associated `stream` from the current position of the cursor down.
|
|
61
|
+
* Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
|
|
62
|
+
*/
|
|
63
|
+
clearScreenDown(): this;
|
|
64
|
+
/**
|
|
65
|
+
* The `rl.commit()` method sends all the pending actions to the associated `stream` and clears the internal list of pending actions.
|
|
66
|
+
*/
|
|
67
|
+
commit(): Promise<void>;
|
|
68
|
+
/**
|
|
69
|
+
* The `rl.cursorTo()` method adds to the internal list of pending action an action that moves cursor to the specified position in the associated `stream`.
|
|
70
|
+
* Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
|
|
71
|
+
*/
|
|
72
|
+
cursorTo(x: number, y?: number): this;
|
|
73
|
+
/**
|
|
74
|
+
* The `rl.moveCursor()` method adds to the internal list of pending action an action that moves the cursor relative to its current position in the associated `stream`.
|
|
75
|
+
* Call `rl.commit()` to see the effect of this method, unless autoCommit: true was passed to the constructor.
|
|
76
|
+
*/
|
|
77
|
+
moveCursor(dx: number, dy: number): this;
|
|
78
|
+
/**
|
|
79
|
+
* The `rl.rollback()` method clears the internal list of pending actions without sending it to the associated `stream`.
|
|
80
|
+
*/
|
|
81
|
+
rollback(): this;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface` instance.
|
|
86
|
+
*
|
|
87
|
+
* ```js
|
|
88
|
+
* const readlinePromises = require('node:readline/promises');
|
|
89
|
+
* const rl = readlinePromises.createInterface({
|
|
90
|
+
* input: process.stdin,
|
|
91
|
+
* output: process.stdout
|
|
92
|
+
* });
|
|
93
|
+
* ```
|
|
94
|
+
*
|
|
95
|
+
* Once the `readlinePromises.Interface` instance is created, the most common case is to listen for the `'line'` event:
|
|
96
|
+
*
|
|
97
|
+
* ```js
|
|
98
|
+
* rl.on('line', (line) => {
|
|
99
|
+
* console.log(`Received: ${line}`);
|
|
100
|
+
* });
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
103
|
+
* If `terminal` is `true` for this instance then the `output` stream will get the best compatibility if it defines an `output.columns` property,
|
|
104
|
+
* and emits a `'resize'` event on the `output`, if or when the columns ever change (`process.stdout` does this automatically when it is a TTY).
|
|
105
|
+
*
|
|
106
|
+
* ## Use of the `completer` function
|
|
107
|
+
*
|
|
108
|
+
* The `completer` function takes the current line entered by the user as an argument, and returns an `Array` with 2 entries:
|
|
109
|
+
*
|
|
110
|
+
* - An Array with matching entries for the completion.
|
|
111
|
+
* - The substring that was used for the matching.
|
|
112
|
+
*
|
|
113
|
+
* For instance: `[[substr1, substr2, ...], originalsubstring]`.
|
|
114
|
+
*
|
|
115
|
+
* ```js
|
|
116
|
+
* function completer(line) {
|
|
117
|
+
* const completions = '.help .error .exit .quit .q'.split(' ');
|
|
118
|
+
* const hits = completions.filter((c) => c.startsWith(line));
|
|
119
|
+
* // Show all completions if none found
|
|
120
|
+
* return [hits.length ? hits : completions, line];
|
|
121
|
+
* }
|
|
122
|
+
* ```
|
|
123
|
+
*
|
|
124
|
+
* The `completer` function can also returns a `Promise`, or be asynchronous:
|
|
125
|
+
*
|
|
126
|
+
* ```js
|
|
127
|
+
* async function completer(linePartial) {
|
|
128
|
+
* await someAsyncWork();
|
|
129
|
+
* return [['123'], linePartial];
|
|
130
|
+
* }
|
|
131
|
+
* ```
|
|
132
|
+
*/
|
|
133
|
+
function createInterface(
|
|
134
|
+
input: NodeJS.ReadableStream,
|
|
135
|
+
output?: NodeJS.WritableStream,
|
|
136
|
+
completer?: Completer | AsyncCompleter,
|
|
137
|
+
terminal?: boolean,
|
|
138
|
+
): Interface;
|
|
139
|
+
function createInterface(options: ReadLineOptions): Interface;
|
|
140
|
+
}
|
|
141
|
+
declare module 'node:readline/promises' {
|
|
142
|
+
export * from 'readline/promises';
|
|
143
|
+
}
|
|
@@ -34,7 +34,10 @@
|
|
|
34
34
|
*/
|
|
35
35
|
declare module 'readline' {
|
|
36
36
|
import { Abortable, EventEmitter } from 'node:events';
|
|
37
|
-
|
|
37
|
+
import * as promises from 'node:readline/promises';
|
|
38
|
+
|
|
39
|
+
export { promises };
|
|
40
|
+
export interface Key {
|
|
38
41
|
sequence?: string | undefined;
|
|
39
42
|
name?: string | undefined;
|
|
40
43
|
ctrl?: boolean | undefined;
|
|
@@ -48,7 +51,7 @@ declare module 'readline' {
|
|
|
48
51
|
* and is read from, the `input` stream.
|
|
49
52
|
* @since v0.1.104
|
|
50
53
|
*/
|
|
51
|
-
class Interface extends EventEmitter {
|
|
54
|
+
export class Interface extends EventEmitter {
|
|
52
55
|
readonly terminal: boolean;
|
|
53
56
|
/**
|
|
54
57
|
* The current input data being processed by node.
|
|
@@ -315,11 +318,11 @@ declare module 'readline' {
|
|
|
315
318
|
prependOnceListener(event: 'history', listener: (history: string[]) => void): this;
|
|
316
319
|
[Symbol.asyncIterator](): AsyncIterableIterator<string>;
|
|
317
320
|
}
|
|
318
|
-
type ReadLine = Interface; // type forwarded for backwards compatibility
|
|
319
|
-
type Completer = (line: string) => CompleterResult;
|
|
320
|
-
type AsyncCompleter = (line: string, callback: (err?: null | Error, result?: CompleterResult) => void) => void;
|
|
321
|
-
type CompleterResult = [string[], string];
|
|
322
|
-
interface ReadLineOptions {
|
|
321
|
+
export type ReadLine = Interface; // type forwarded for backwards compatibility
|
|
322
|
+
export type Completer = (line: string) => CompleterResult;
|
|
323
|
+
export type AsyncCompleter = (line: string, callback: (err?: null | Error, result?: CompleterResult) => void) => void;
|
|
324
|
+
export type CompleterResult = [string[], string];
|
|
325
|
+
export interface ReadLineOptions {
|
|
323
326
|
input: NodeJS.ReadableStream;
|
|
324
327
|
output?: NodeJS.WritableStream | undefined;
|
|
325
328
|
completer?: Completer | AsyncCompleter | undefined;
|
|
@@ -380,8 +383,8 @@ declare module 'readline' {
|
|
|
380
383
|
* ```
|
|
381
384
|
* @since v0.1.98
|
|
382
385
|
*/
|
|
383
|
-
function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean): Interface;
|
|
384
|
-
function createInterface(options: ReadLineOptions): Interface;
|
|
386
|
+
export function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean): Interface;
|
|
387
|
+
export function createInterface(options: ReadLineOptions): Interface;
|
|
385
388
|
/**
|
|
386
389
|
* The `readline.emitKeypressEvents()` method causes the given `Readable` stream to begin emitting `'keypress'` events corresponding to received input.
|
|
387
390
|
*
|
|
@@ -503,9 +506,9 @@ declare module 'readline' {
|
|
|
503
506
|
* ```
|
|
504
507
|
* @since v0.7.7
|
|
505
508
|
*/
|
|
506
|
-
function emitKeypressEvents(stream: NodeJS.ReadableStream, readlineInterface?: Interface): void;
|
|
507
|
-
type Direction = -1 | 0 | 1;
|
|
508
|
-
interface CursorPos {
|
|
509
|
+
export function emitKeypressEvents(stream: NodeJS.ReadableStream, readlineInterface?: Interface): void;
|
|
510
|
+
export type Direction = -1 | 0 | 1;
|
|
511
|
+
export interface CursorPos {
|
|
509
512
|
rows: number;
|
|
510
513
|
cols: number;
|
|
511
514
|
}
|
|
@@ -516,7 +519,7 @@ declare module 'readline' {
|
|
|
516
519
|
* @param callback Invoked once the operation completes.
|
|
517
520
|
* @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
|
|
518
521
|
*/
|
|
519
|
-
function clearLine(stream: NodeJS.WritableStream, dir: Direction, callback?: () => void): boolean;
|
|
522
|
+
export function clearLine(stream: NodeJS.WritableStream, dir: Direction, callback?: () => void): boolean;
|
|
520
523
|
/**
|
|
521
524
|
* The `readline.clearScreenDown()` method clears the given `TTY` stream from
|
|
522
525
|
* the current position of the cursor down.
|
|
@@ -524,7 +527,7 @@ declare module 'readline' {
|
|
|
524
527
|
* @param callback Invoked once the operation completes.
|
|
525
528
|
* @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
|
|
526
529
|
*/
|
|
527
|
-
function clearScreenDown(stream: NodeJS.WritableStream, callback?: () => void): boolean;
|
|
530
|
+
export function clearScreenDown(stream: NodeJS.WritableStream, callback?: () => void): boolean;
|
|
528
531
|
/**
|
|
529
532
|
* The `readline.cursorTo()` method moves cursor to the specified position in a
|
|
530
533
|
* given `TTY` `stream`.
|
|
@@ -532,7 +535,7 @@ declare module 'readline' {
|
|
|
532
535
|
* @param callback Invoked once the operation completes.
|
|
533
536
|
* @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
|
|
534
537
|
*/
|
|
535
|
-
function cursorTo(stream: NodeJS.WritableStream, x: number, y?: number, callback?: () => void): boolean;
|
|
538
|
+
export function cursorTo(stream: NodeJS.WritableStream, x: number, y?: number, callback?: () => void): boolean;
|
|
536
539
|
/**
|
|
537
540
|
* The `readline.moveCursor()` method moves the cursor _relative_ to its current
|
|
538
541
|
* position in a given `TTY` `stream`.
|
|
@@ -643,7 +646,7 @@ declare module 'readline' {
|
|
|
643
646
|
* @param callback Invoked once the operation completes.
|
|
644
647
|
* @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
|
|
645
648
|
*/
|
|
646
|
-
function moveCursor(stream: NodeJS.WritableStream, dx: number, dy: number, callback?: () => void): boolean;
|
|
649
|
+
export function moveCursor(stream: NodeJS.WritableStream, dx: number, dy: number, callback?: () => void): boolean;
|
|
647
650
|
}
|
|
648
651
|
declare module 'node:readline' {
|
|
649
652
|
export * from 'readline';
|
|
@@ -8,7 +8,7 @@ This package contains type definitions for Node.js (https://nodejs.org/).
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Sat, 13 Aug 2022 13:02:04 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `AbortController`, `AbortSignal`, `__dirname`, `__filename`, `console`, `exports`, `gc`, `global`, `module`, `process`, `require`, `structuredClone`
|
|
14
14
|
|
|
@@ -108,6 +108,7 @@
|
|
|
108
108
|
/// <reference path="punycode.d.ts" />
|
|
109
109
|
/// <reference path="querystring.d.ts" />
|
|
110
110
|
/// <reference path="readline.d.ts" />
|
|
111
|
+
/// <reference path="readline/promises.d.ts" />
|
|
111
112
|
/// <reference path="repl.d.ts" />
|
|
112
113
|
/// <reference path="stream.d.ts" />
|
|
113
114
|
/// <reference path="stream/promises.d.ts" />
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/node",
|
|
3
|
-
"version": "18.7.
|
|
3
|
+
"version": "18.7.3",
|
|
4
4
|
"description": "TypeScript definitions for Node.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
|
|
6
6
|
"license": "MIT",
|
|
@@ -220,6 +220,6 @@
|
|
|
220
220
|
},
|
|
221
221
|
"scripts": {},
|
|
222
222
|
"dependencies": {},
|
|
223
|
-
"typesPublisherContentHash": "
|
|
223
|
+
"typesPublisherContentHash": "8dea3d15b6bef937e990a6b11572d052d6b749766317804596d909c7e26211e5",
|
|
224
224
|
"typeScriptVersion": "4.0"
|
|
225
225
|
}
|
|
@@ -191,6 +191,35 @@ declare module 'perf_hooks' {
|
|
|
191
191
|
* @param name
|
|
192
192
|
*/
|
|
193
193
|
clearMarks(name?: string): void;
|
|
194
|
+
/**
|
|
195
|
+
* If name is not provided, removes all PerformanceMeasure objects from the Performance Timeline.
|
|
196
|
+
* If name is provided, removes only the named measure.
|
|
197
|
+
* @param name
|
|
198
|
+
* @since v16.7.0
|
|
199
|
+
*/
|
|
200
|
+
clearMeasures(name?: string): void;
|
|
201
|
+
/**
|
|
202
|
+
* Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`.
|
|
203
|
+
* If you are only interested in performance entries of certain types or that have certain names, see
|
|
204
|
+
* `performance.getEntriesByType()` and `performance.getEntriesByName()`.
|
|
205
|
+
* @since v16.7.0
|
|
206
|
+
*/
|
|
207
|
+
getEntries(): PerformanceEntry[];
|
|
208
|
+
/**
|
|
209
|
+
* Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`
|
|
210
|
+
* whose `performanceEntry.name` is equal to `name`, and optionally, whose `performanceEntry.entryType` is equal to `type`.
|
|
211
|
+
* @param name
|
|
212
|
+
* @param type
|
|
213
|
+
* @since v16.7.0
|
|
214
|
+
*/
|
|
215
|
+
getEntriesByName(name: string, type?: EntryType): PerformanceEntry[];
|
|
216
|
+
/**
|
|
217
|
+
* Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`
|
|
218
|
+
* whose `performanceEntry.entryType` is equal to `type`.
|
|
219
|
+
* @param type
|
|
220
|
+
* @since v16.7.0
|
|
221
|
+
*/
|
|
222
|
+
getEntriesByType(type: EntryType): PerformanceEntry[];
|
|
194
223
|
/**
|
|
195
224
|
* Creates a new PerformanceMark entry in the Performance Timeline.
|
|
196
225
|
* A PerformanceMark is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'mark',
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The `readline/promise` module provides an API for reading lines of input from a Readable stream one line at a time.
|
|
3
|
+
*
|
|
4
|
+
* @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/readline/promises.js)
|
|
5
|
+
* @since v17.0.0
|
|
6
|
+
*/
|
|
7
|
+
declare module 'readline/promises' {
|
|
8
|
+
import { Interface as _Interface, ReadLineOptions, Completer, AsyncCompleter, Direction } from 'node:readline';
|
|
9
|
+
import { Abortable } from 'node:events';
|
|
10
|
+
|
|
11
|
+
class Interface extends _Interface {
|
|
12
|
+
/**
|
|
13
|
+
* The rl.question() method displays the query by writing it to the output, waits for user input to be provided on input,
|
|
14
|
+
* then invokes the callback function passing the provided input as the first argument.
|
|
15
|
+
*
|
|
16
|
+
* When called, rl.question() will resume the input stream if it has been paused.
|
|
17
|
+
*
|
|
18
|
+
* If the readlinePromises.Interface was created with output set to null or undefined the query is not written.
|
|
19
|
+
*
|
|
20
|
+
* If the question is called after rl.close(), it returns a rejected promise.
|
|
21
|
+
*
|
|
22
|
+
* Example usage:
|
|
23
|
+
*
|
|
24
|
+
* ```js
|
|
25
|
+
* const answer = await rl.question('What is your favorite food? ');
|
|
26
|
+
* console.log(`Oh, so your favorite food is ${answer}`);
|
|
27
|
+
* ```
|
|
28
|
+
*
|
|
29
|
+
* Using an AbortSignal to cancel a question.
|
|
30
|
+
*
|
|
31
|
+
* ```js
|
|
32
|
+
* const signal = AbortSignal.timeout(10_000);
|
|
33
|
+
*
|
|
34
|
+
* signal.addEventListener('abort', () => {
|
|
35
|
+
* console.log('The food question timed out');
|
|
36
|
+
* }, { once: true });
|
|
37
|
+
*
|
|
38
|
+
* const answer = await rl.question('What is your favorite food? ', { signal });
|
|
39
|
+
* console.log(`Oh, so your favorite food is ${answer}`);
|
|
40
|
+
* ```
|
|
41
|
+
*
|
|
42
|
+
* @since v17.0.0
|
|
43
|
+
* @param query A statement or query to write to output, prepended to the prompt.
|
|
44
|
+
*/
|
|
45
|
+
question(query: string): Promise<string>;
|
|
46
|
+
question(query: string, options: Abortable): Promise<string>;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
class Readline {
|
|
50
|
+
/**
|
|
51
|
+
* @param stream A TTY stream.
|
|
52
|
+
*/
|
|
53
|
+
constructor(stream: NodeJS.WritableStream, options?: { autoCommit?: boolean });
|
|
54
|
+
/**
|
|
55
|
+
* The `rl.clearLine()` method adds to the internal list of pending action an action that clears current line of the associated `stream` in a specified direction identified by `dir`.
|
|
56
|
+
* Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
|
|
57
|
+
*/
|
|
58
|
+
clearLine(dir: Direction): this;
|
|
59
|
+
/**
|
|
60
|
+
* The `rl.clearScreenDown()` method adds to the internal list of pending action an action that clears the associated `stream` from the current position of the cursor down.
|
|
61
|
+
* Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
|
|
62
|
+
*/
|
|
63
|
+
clearScreenDown(): this;
|
|
64
|
+
/**
|
|
65
|
+
* The `rl.commit()` method sends all the pending actions to the associated `stream` and clears the internal list of pending actions.
|
|
66
|
+
*/
|
|
67
|
+
commit(): Promise<void>;
|
|
68
|
+
/**
|
|
69
|
+
* The `rl.cursorTo()` method adds to the internal list of pending action an action that moves cursor to the specified position in the associated `stream`.
|
|
70
|
+
* Call `rl.commit()` to see the effect of this method, unless `autoCommit: true` was passed to the constructor.
|
|
71
|
+
*/
|
|
72
|
+
cursorTo(x: number, y?: number): this;
|
|
73
|
+
/**
|
|
74
|
+
* The `rl.moveCursor()` method adds to the internal list of pending action an action that moves the cursor relative to its current position in the associated `stream`.
|
|
75
|
+
* Call `rl.commit()` to see the effect of this method, unless autoCommit: true was passed to the constructor.
|
|
76
|
+
*/
|
|
77
|
+
moveCursor(dx: number, dy: number): this;
|
|
78
|
+
/**
|
|
79
|
+
* The `rl.rollback()` method clears the internal list of pending actions without sending it to the associated `stream`.
|
|
80
|
+
*/
|
|
81
|
+
rollback(): this;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* The `readlinePromises.createInterface()` method creates a new `readlinePromises.Interface` instance.
|
|
86
|
+
*
|
|
87
|
+
* ```js
|
|
88
|
+
* const readlinePromises = require('node:readline/promises');
|
|
89
|
+
* const rl = readlinePromises.createInterface({
|
|
90
|
+
* input: process.stdin,
|
|
91
|
+
* output: process.stdout
|
|
92
|
+
* });
|
|
93
|
+
* ```
|
|
94
|
+
*
|
|
95
|
+
* Once the `readlinePromises.Interface` instance is created, the most common case is to listen for the `'line'` event:
|
|
96
|
+
*
|
|
97
|
+
* ```js
|
|
98
|
+
* rl.on('line', (line) => {
|
|
99
|
+
* console.log(`Received: ${line}`);
|
|
100
|
+
* });
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
103
|
+
* If `terminal` is `true` for this instance then the `output` stream will get the best compatibility if it defines an `output.columns` property,
|
|
104
|
+
* and emits a `'resize'` event on the `output`, if or when the columns ever change (`process.stdout` does this automatically when it is a TTY).
|
|
105
|
+
*
|
|
106
|
+
* ## Use of the `completer` function
|
|
107
|
+
*
|
|
108
|
+
* The `completer` function takes the current line entered by the user as an argument, and returns an `Array` with 2 entries:
|
|
109
|
+
*
|
|
110
|
+
* - An Array with matching entries for the completion.
|
|
111
|
+
* - The substring that was used for the matching.
|
|
112
|
+
*
|
|
113
|
+
* For instance: `[[substr1, substr2, ...], originalsubstring]`.
|
|
114
|
+
*
|
|
115
|
+
* ```js
|
|
116
|
+
* function completer(line) {
|
|
117
|
+
* const completions = '.help .error .exit .quit .q'.split(' ');
|
|
118
|
+
* const hits = completions.filter((c) => c.startsWith(line));
|
|
119
|
+
* // Show all completions if none found
|
|
120
|
+
* return [hits.length ? hits : completions, line];
|
|
121
|
+
* }
|
|
122
|
+
* ```
|
|
123
|
+
*
|
|
124
|
+
* The `completer` function can also returns a `Promise`, or be asynchronous:
|
|
125
|
+
*
|
|
126
|
+
* ```js
|
|
127
|
+
* async function completer(linePartial) {
|
|
128
|
+
* await someAsyncWork();
|
|
129
|
+
* return [['123'], linePartial];
|
|
130
|
+
* }
|
|
131
|
+
* ```
|
|
132
|
+
*/
|
|
133
|
+
function createInterface(
|
|
134
|
+
input: NodeJS.ReadableStream,
|
|
135
|
+
output?: NodeJS.WritableStream,
|
|
136
|
+
completer?: Completer | AsyncCompleter,
|
|
137
|
+
terminal?: boolean,
|
|
138
|
+
): Interface;
|
|
139
|
+
function createInterface(options: ReadLineOptions): Interface;
|
|
140
|
+
}
|
|
141
|
+
declare module 'node:readline/promises' {
|
|
142
|
+
export * from 'readline/promises';
|
|
143
|
+
}
|