@alanszp/express 12.0.2 → 13.0.0

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 (180) hide show
  1. package/dist/helpers/getRequestBaseLog.d.ts +2 -0
  2. package/dist/helpers/getRequestBaseLog.js +9 -0
  3. package/dist/helpers/getRequestBaseLog.js.map +1 -0
  4. package/dist/helpers/renderErrorJson.d.ts +1 -0
  5. package/dist/helpers/renderErrorJson.js +10 -1
  6. package/dist/helpers/renderErrorJson.js.map +1 -1
  7. package/dist/index.d.ts +3 -1
  8. package/dist/index.js +3 -1
  9. package/dist/index.js.map +1 -1
  10. package/dist/middlewares/errorRequestHandlerMiddleware.d.ts +4 -0
  11. package/dist/middlewares/errorRequestHandlerMiddleware.js +68 -0
  12. package/dist/middlewares/errorRequestHandlerMiddleware.js.map +1 -0
  13. package/dist/middlewares/hasPermissions.d.ts +20 -0
  14. package/dist/middlewares/hasPermissions.js +90 -0
  15. package/dist/middlewares/hasPermissions.js.map +1 -0
  16. package/dist/middlewares/hasRoles.js +4 -4
  17. package/dist/middlewares/hasRoles.js.map +1 -1
  18. package/package.json +9 -10
  19. package/.gitignore +0 -3
  20. package/.npmignore +0 -3
  21. package/dist/middlewares/returnInternalServerError.d.ts +0 -4
  22. package/dist/middlewares/returnInternalServerError.js +0 -10
  23. package/dist/middlewares/returnInternalServerError.js.map +0 -1
  24. package/node_modules/@jest/expect-utils/LICENSE +0 -21
  25. package/node_modules/@jest/expect-utils/README.md +0 -5
  26. package/node_modules/@jest/expect-utils/build/index.d.ts +0 -93
  27. package/node_modules/@jest/expect-utils/build/index.js +0 -37
  28. package/node_modules/@jest/expect-utils/build/jasmineUtils.js +0 -282
  29. package/node_modules/@jest/expect-utils/build/types.js +0 -1
  30. package/node_modules/@jest/expect-utils/build/utils.js +0 -457
  31. package/node_modules/@jest/expect-utils/package.json +0 -33
  32. package/node_modules/@jest/types/LICENSE +0 -21
  33. package/node_modules/@jest/types/README.md +0 -30
  34. package/node_modules/@jest/types/build/Circus.js +0 -1
  35. package/node_modules/@jest/types/build/Config.js +0 -1
  36. package/node_modules/@jest/types/build/Global.js +0 -1
  37. package/node_modules/@jest/types/build/TestResult.js +0 -1
  38. package/node_modules/@jest/types/build/Transform.js +0 -1
  39. package/node_modules/@jest/types/build/index.d.ts +0 -1166
  40. package/node_modules/@jest/types/build/index.js +0 -1
  41. package/node_modules/@jest/types/package.json +0 -38
  42. package/node_modules/@types/jest/LICENSE +0 -21
  43. package/node_modules/@types/jest/README.md +0 -17
  44. package/node_modules/@types/jest/index.d.ts +0 -1608
  45. package/node_modules/@types/jest/package.json +0 -159
  46. package/node_modules/@types/node/LICENSE +0 -21
  47. package/node_modules/@types/node/README.md +0 -15
  48. package/node_modules/@types/node/assert/strict.d.ts +0 -8
  49. package/node_modules/@types/node/assert.d.ts +0 -996
  50. package/node_modules/@types/node/async_hooks.d.ts +0 -539
  51. package/node_modules/@types/node/buffer.d.ts +0 -2362
  52. package/node_modules/@types/node/child_process.d.ts +0 -1540
  53. package/node_modules/@types/node/cluster.d.ts +0 -432
  54. package/node_modules/@types/node/console.d.ts +0 -415
  55. package/node_modules/@types/node/constants.d.ts +0 -19
  56. package/node_modules/@types/node/crypto.d.ts +0 -4487
  57. package/node_modules/@types/node/dgram.d.ts +0 -596
  58. package/node_modules/@types/node/diagnostics_channel.d.ts +0 -545
  59. package/node_modules/@types/node/dns/promises.d.ts +0 -425
  60. package/node_modules/@types/node/dns.d.ts +0 -809
  61. package/node_modules/@types/node/dom-events.d.ts +0 -122
  62. package/node_modules/@types/node/domain.d.ts +0 -170
  63. package/node_modules/@types/node/events.d.ts +0 -879
  64. package/node_modules/@types/node/fs/promises.d.ts +0 -1239
  65. package/node_modules/@types/node/fs.d.ts +0 -4311
  66. package/node_modules/@types/node/globals.d.ts +0 -411
  67. package/node_modules/@types/node/globals.global.d.ts +0 -1
  68. package/node_modules/@types/node/http.d.ts +0 -1887
  69. package/node_modules/@types/node/http2.d.ts +0 -2382
  70. package/node_modules/@types/node/https.d.ts +0 -550
  71. package/node_modules/@types/node/index.d.ts +0 -88
  72. package/node_modules/@types/node/inspector.d.ts +0 -2747
  73. package/node_modules/@types/node/module.d.ts +0 -315
  74. package/node_modules/@types/node/net.d.ts +0 -949
  75. package/node_modules/@types/node/os.d.ts +0 -478
  76. package/node_modules/@types/node/package.json +0 -229
  77. package/node_modules/@types/node/path.d.ts +0 -191
  78. package/node_modules/@types/node/perf_hooks.d.ts +0 -645
  79. package/node_modules/@types/node/process.d.ts +0 -1561
  80. package/node_modules/@types/node/punycode.d.ts +0 -117
  81. package/node_modules/@types/node/querystring.d.ts +0 -141
  82. package/node_modules/@types/node/readline/promises.d.ts +0 -150
  83. package/node_modules/@types/node/readline.d.ts +0 -539
  84. package/node_modules/@types/node/repl.d.ts +0 -430
  85. package/node_modules/@types/node/stream/consumers.d.ts +0 -12
  86. package/node_modules/@types/node/stream/promises.d.ts +0 -83
  87. package/node_modules/@types/node/stream/web.d.ts +0 -366
  88. package/node_modules/@types/node/stream.d.ts +0 -1701
  89. package/node_modules/@types/node/string_decoder.d.ts +0 -67
  90. package/node_modules/@types/node/test.d.ts +0 -1465
  91. package/node_modules/@types/node/timers/promises.d.ts +0 -93
  92. package/node_modules/@types/node/timers.d.ts +0 -240
  93. package/node_modules/@types/node/tls.d.ts +0 -1210
  94. package/node_modules/@types/node/trace_events.d.ts +0 -182
  95. package/node_modules/@types/node/ts4.8/assert/strict.d.ts +0 -8
  96. package/node_modules/@types/node/ts4.8/assert.d.ts +0 -996
  97. package/node_modules/@types/node/ts4.8/async_hooks.d.ts +0 -539
  98. package/node_modules/@types/node/ts4.8/buffer.d.ts +0 -2362
  99. package/node_modules/@types/node/ts4.8/child_process.d.ts +0 -1540
  100. package/node_modules/@types/node/ts4.8/cluster.d.ts +0 -432
  101. package/node_modules/@types/node/ts4.8/console.d.ts +0 -415
  102. package/node_modules/@types/node/ts4.8/constants.d.ts +0 -19
  103. package/node_modules/@types/node/ts4.8/crypto.d.ts +0 -4487
  104. package/node_modules/@types/node/ts4.8/dgram.d.ts +0 -596
  105. package/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +0 -545
  106. package/node_modules/@types/node/ts4.8/dns/promises.d.ts +0 -425
  107. package/node_modules/@types/node/ts4.8/dns.d.ts +0 -809
  108. package/node_modules/@types/node/ts4.8/dom-events.d.ts +0 -122
  109. package/node_modules/@types/node/ts4.8/domain.d.ts +0 -170
  110. package/node_modules/@types/node/ts4.8/events.d.ts +0 -879
  111. package/node_modules/@types/node/ts4.8/fs/promises.d.ts +0 -1239
  112. package/node_modules/@types/node/ts4.8/fs.d.ts +0 -4311
  113. package/node_modules/@types/node/ts4.8/globals.d.ts +0 -411
  114. package/node_modules/@types/node/ts4.8/globals.global.d.ts +0 -1
  115. package/node_modules/@types/node/ts4.8/http.d.ts +0 -1887
  116. package/node_modules/@types/node/ts4.8/http2.d.ts +0 -2382
  117. package/node_modules/@types/node/ts4.8/https.d.ts +0 -550
  118. package/node_modules/@types/node/ts4.8/index.d.ts +0 -88
  119. package/node_modules/@types/node/ts4.8/inspector.d.ts +0 -2747
  120. package/node_modules/@types/node/ts4.8/module.d.ts +0 -315
  121. package/node_modules/@types/node/ts4.8/net.d.ts +0 -949
  122. package/node_modules/@types/node/ts4.8/os.d.ts +0 -478
  123. package/node_modules/@types/node/ts4.8/path.d.ts +0 -191
  124. package/node_modules/@types/node/ts4.8/perf_hooks.d.ts +0 -645
  125. package/node_modules/@types/node/ts4.8/process.d.ts +0 -1561
  126. package/node_modules/@types/node/ts4.8/punycode.d.ts +0 -117
  127. package/node_modules/@types/node/ts4.8/querystring.d.ts +0 -141
  128. package/node_modules/@types/node/ts4.8/readline/promises.d.ts +0 -150
  129. package/node_modules/@types/node/ts4.8/readline.d.ts +0 -539
  130. package/node_modules/@types/node/ts4.8/repl.d.ts +0 -430
  131. package/node_modules/@types/node/ts4.8/stream/consumers.d.ts +0 -12
  132. package/node_modules/@types/node/ts4.8/stream/promises.d.ts +0 -83
  133. package/node_modules/@types/node/ts4.8/stream/web.d.ts +0 -366
  134. package/node_modules/@types/node/ts4.8/stream.d.ts +0 -1701
  135. package/node_modules/@types/node/ts4.8/string_decoder.d.ts +0 -67
  136. package/node_modules/@types/node/ts4.8/test.d.ts +0 -1465
  137. package/node_modules/@types/node/ts4.8/timers/promises.d.ts +0 -93
  138. package/node_modules/@types/node/ts4.8/timers.d.ts +0 -240
  139. package/node_modules/@types/node/ts4.8/tls.d.ts +0 -1210
  140. package/node_modules/@types/node/ts4.8/trace_events.d.ts +0 -182
  141. package/node_modules/@types/node/ts4.8/tty.d.ts +0 -208
  142. package/node_modules/@types/node/ts4.8/url.d.ts +0 -927
  143. package/node_modules/@types/node/ts4.8/util.d.ts +0 -2183
  144. package/node_modules/@types/node/ts4.8/v8.d.ts +0 -764
  145. package/node_modules/@types/node/ts4.8/vm.d.ts +0 -903
  146. package/node_modules/@types/node/ts4.8/wasi.d.ts +0 -179
  147. package/node_modules/@types/node/ts4.8/worker_threads.d.ts +0 -691
  148. package/node_modules/@types/node/ts4.8/zlib.d.ts +0 -517
  149. package/node_modules/@types/node/tty.d.ts +0 -208
  150. package/node_modules/@types/node/url.d.ts +0 -927
  151. package/node_modules/@types/node/util.d.ts +0 -2183
  152. package/node_modules/@types/node/v8.d.ts +0 -764
  153. package/node_modules/@types/node/vm.d.ts +0 -903
  154. package/node_modules/@types/node/wasi.d.ts +0 -179
  155. package/node_modules/@types/node/worker_threads.d.ts +0 -691
  156. package/node_modules/@types/node/zlib.d.ts +0 -517
  157. package/src/helpers/getIp.ts +0 -5
  158. package/src/helpers/getRequestLogger.ts +0 -6
  159. package/src/helpers/now.ts +0 -3
  160. package/src/helpers/renderErrorJson.ts +0 -29
  161. package/src/index.ts +0 -10
  162. package/src/middlewares/accessLogger.ts +0 -34
  163. package/src/middlewares/auditLog.ts +0 -52
  164. package/src/middlewares/authedForOrg.ts +0 -50
  165. package/src/middlewares/authenticateUser.test.ts +0 -403
  166. package/src/middlewares/authenticateUser.ts +0 -171
  167. package/src/middlewares/createContext.test.ts +0 -85
  168. package/src/middlewares/createContext.ts +0 -49
  169. package/src/middlewares/hasRoles.ts +0 -24
  170. package/src/middlewares/jsonBodyParser.ts +0 -22
  171. package/src/middlewares/returnInternalServerError.ts +0 -15
  172. package/src/middlewares/returnNotFound.ts +0 -11
  173. package/src/test/mocks/authOptionsMocks.ts +0 -35
  174. package/src/test/mocks/expressMocks.ts +0 -33
  175. package/src/test/mocks/jwtUserMocks.ts +0 -19
  176. package/src/test/setup.test.ts +0 -15
  177. package/src/test/setup.ts +0 -3
  178. package/src/types/AuthMethod.ts +0 -27
  179. package/src/types/GenericRequest.ts +0 -3
  180. package/src/types/custom.d.ts +0 -20
@@ -1,430 +0,0 @@
1
- /**
2
- * The `node:repl` module provides a Read-Eval-Print-Loop (REPL) implementation
3
- * that is available both as a standalone program or includible in other
4
- * applications. It can be accessed using:
5
- *
6
- * ```js
7
- * const repl = require('node:repl');
8
- * ```
9
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/repl.js)
10
- */
11
- declare module "repl" {
12
- import { AsyncCompleter, Completer, Interface } from "node:readline";
13
- import { Context } from "node:vm";
14
- import { InspectOptions } from "node:util";
15
- interface ReplOptions {
16
- /**
17
- * The input prompt to display.
18
- * @default "> "
19
- */
20
- prompt?: string | undefined;
21
- /**
22
- * The `Readable` stream from which REPL input will be read.
23
- * @default process.stdin
24
- */
25
- input?: NodeJS.ReadableStream | undefined;
26
- /**
27
- * The `Writable` stream to which REPL output will be written.
28
- * @default process.stdout
29
- */
30
- output?: NodeJS.WritableStream | undefined;
31
- /**
32
- * If `true`, specifies that the output should be treated as a TTY terminal, and have
33
- * ANSI/VT100 escape codes written to it.
34
- * Default: checking the value of the `isTTY` property on the output stream upon
35
- * instantiation.
36
- */
37
- terminal?: boolean | undefined;
38
- /**
39
- * The function to be used when evaluating each given line of input.
40
- * Default: an async wrapper for the JavaScript `eval()` function. An `eval` function can
41
- * error with `repl.Recoverable` to indicate the input was incomplete and prompt for
42
- * additional lines.
43
- *
44
- * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_default_evaluation
45
- * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_custom_evaluation_functions
46
- */
47
- eval?: REPLEval | undefined;
48
- /**
49
- * Defines if the repl prints output previews or not.
50
- * @default `true` Always `false` in case `terminal` is falsy.
51
- */
52
- preview?: boolean | undefined;
53
- /**
54
- * If `true`, specifies that the default `writer` function should include ANSI color
55
- * styling to REPL output. If a custom `writer` function is provided then this has no
56
- * effect.
57
- * Default: the REPL instance's `terminal` value.
58
- */
59
- useColors?: boolean | undefined;
60
- /**
61
- * If `true`, specifies that the default evaluation function will use the JavaScript
62
- * `global` as the context as opposed to creating a new separate context for the REPL
63
- * instance. The node CLI REPL sets this value to `true`.
64
- * Default: `false`.
65
- */
66
- useGlobal?: boolean | undefined;
67
- /**
68
- * If `true`, specifies that the default writer will not output the return value of a
69
- * command if it evaluates to `undefined`.
70
- * Default: `false`.
71
- */
72
- ignoreUndefined?: boolean | undefined;
73
- /**
74
- * The function to invoke to format the output of each command before writing to `output`.
75
- * Default: a wrapper for `util.inspect`.
76
- *
77
- * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_customizing_repl_output
78
- */
79
- writer?: REPLWriter | undefined;
80
- /**
81
- * An optional function used for custom Tab auto completion.
82
- *
83
- * @see https://nodejs.org/dist/latest-v20.x/docs/api/readline.html#readline_use_of_the_completer_function
84
- */
85
- completer?: Completer | AsyncCompleter | undefined;
86
- /**
87
- * A flag that specifies whether the default evaluator executes all JavaScript commands in
88
- * strict mode or default (sloppy) mode.
89
- * Accepted values are:
90
- * - `repl.REPL_MODE_SLOPPY` - evaluates expressions in sloppy mode.
91
- * - `repl.REPL_MODE_STRICT` - evaluates expressions in strict mode. This is equivalent to
92
- * prefacing every repl statement with `'use strict'`.
93
- */
94
- replMode?: typeof REPL_MODE_SLOPPY | typeof REPL_MODE_STRICT | undefined;
95
- /**
96
- * Stop evaluating the current piece of code when `SIGINT` is received, i.e. `Ctrl+C` is
97
- * pressed. This cannot be used together with a custom `eval` function.
98
- * Default: `false`.
99
- */
100
- breakEvalOnSigint?: boolean | undefined;
101
- }
102
- type REPLEval = (
103
- this: REPLServer,
104
- evalCmd: string,
105
- context: Context,
106
- file: string,
107
- cb: (err: Error | null, result: any) => void,
108
- ) => void;
109
- type REPLWriter = (this: REPLServer, obj: any) => string;
110
- /**
111
- * This is the default "writer" value, if none is passed in the REPL options,
112
- * and it can be overridden by custom print functions.
113
- */
114
- const writer: REPLWriter & {
115
- options: InspectOptions;
116
- };
117
- type REPLCommandAction = (this: REPLServer, text: string) => void;
118
- interface REPLCommand {
119
- /**
120
- * Help text to be displayed when `.help` is entered.
121
- */
122
- help?: string | undefined;
123
- /**
124
- * The function to execute, optionally accepting a single string argument.
125
- */
126
- action: REPLCommandAction;
127
- }
128
- /**
129
- * Instances of `repl.REPLServer` are created using the {@link start} method
130
- * or directly using the JavaScript `new` keyword.
131
- *
132
- * ```js
133
- * const repl = require('node:repl');
134
- *
135
- * const options = { useColors: true };
136
- *
137
- * const firstInstance = repl.start(options);
138
- * const secondInstance = new repl.REPLServer(options);
139
- * ```
140
- * @since v0.1.91
141
- */
142
- class REPLServer extends Interface {
143
- /**
144
- * The `vm.Context` provided to the `eval` function to be used for JavaScript
145
- * evaluation.
146
- */
147
- readonly context: Context;
148
- /**
149
- * @deprecated since v14.3.0 - Use `input` instead.
150
- */
151
- readonly inputStream: NodeJS.ReadableStream;
152
- /**
153
- * @deprecated since v14.3.0 - Use `output` instead.
154
- */
155
- readonly outputStream: NodeJS.WritableStream;
156
- /**
157
- * The `Readable` stream from which REPL input will be read.
158
- */
159
- readonly input: NodeJS.ReadableStream;
160
- /**
161
- * The `Writable` stream to which REPL output will be written.
162
- */
163
- readonly output: NodeJS.WritableStream;
164
- /**
165
- * The commands registered via `replServer.defineCommand()`.
166
- */
167
- readonly commands: NodeJS.ReadOnlyDict<REPLCommand>;
168
- /**
169
- * A value indicating whether the REPL is currently in "editor mode".
170
- *
171
- * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_commands_and_special_keys
172
- */
173
- readonly editorMode: boolean;
174
- /**
175
- * A value indicating whether the `_` variable has been assigned.
176
- *
177
- * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable
178
- */
179
- readonly underscoreAssigned: boolean;
180
- /**
181
- * The last evaluation result from the REPL (assigned to the `_` variable inside of the REPL).
182
- *
183
- * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable
184
- */
185
- readonly last: any;
186
- /**
187
- * A value indicating whether the `_error` variable has been assigned.
188
- *
189
- * @since v9.8.0
190
- * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable
191
- */
192
- readonly underscoreErrAssigned: boolean;
193
- /**
194
- * The last error raised inside the REPL (assigned to the `_error` variable inside of the REPL).
195
- *
196
- * @since v9.8.0
197
- * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable
198
- */
199
- readonly lastError: any;
200
- /**
201
- * Specified in the REPL options, this is the function to be used when evaluating each
202
- * given line of input. If not specified in the REPL options, this is an async wrapper
203
- * for the JavaScript `eval()` function.
204
- */
205
- readonly eval: REPLEval;
206
- /**
207
- * Specified in the REPL options, this is a value indicating whether the default
208
- * `writer` function should include ANSI color styling to REPL output.
209
- */
210
- readonly useColors: boolean;
211
- /**
212
- * Specified in the REPL options, this is a value indicating whether the default `eval`
213
- * function will use the JavaScript `global` as the context as opposed to creating a new
214
- * separate context for the REPL instance.
215
- */
216
- readonly useGlobal: boolean;
217
- /**
218
- * Specified in the REPL options, this is a value indicating whether the default `writer`
219
- * function should output the result of a command if it evaluates to `undefined`.
220
- */
221
- readonly ignoreUndefined: boolean;
222
- /**
223
- * Specified in the REPL options, this is the function to invoke to format the output of
224
- * each command before writing to `outputStream`. If not specified in the REPL options,
225
- * this will be a wrapper for `util.inspect`.
226
- */
227
- readonly writer: REPLWriter;
228
- /**
229
- * Specified in the REPL options, this is the function to use for custom Tab auto-completion.
230
- */
231
- readonly completer: Completer | AsyncCompleter;
232
- /**
233
- * Specified in the REPL options, this is a flag that specifies whether the default `eval`
234
- * function should execute all JavaScript commands in strict mode or default (sloppy) mode.
235
- * Possible values are:
236
- * - `repl.REPL_MODE_SLOPPY` - evaluates expressions in sloppy mode.
237
- * - `repl.REPL_MODE_STRICT` - evaluates expressions in strict mode. This is equivalent to
238
- * prefacing every repl statement with `'use strict'`.
239
- */
240
- readonly replMode: typeof REPL_MODE_SLOPPY | typeof REPL_MODE_STRICT;
241
- /**
242
- * NOTE: According to the documentation:
243
- *
244
- * > Instances of `repl.REPLServer` are created using the `repl.start()` method and
245
- * > _should not_ be created directly using the JavaScript `new` keyword.
246
- *
247
- * `REPLServer` cannot be subclassed due to implementation specifics in NodeJS.
248
- *
249
- * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_class_replserver
250
- */
251
- private constructor();
252
- /**
253
- * The `replServer.defineCommand()` method is used to add new `.`\-prefixed commands
254
- * to the REPL instance. Such commands are invoked by typing a `.` followed by the`keyword`. The `cmd` is either a `Function` or an `Object` with the following
255
- * properties:
256
- *
257
- * The following example shows two new commands added to the REPL instance:
258
- *
259
- * ```js
260
- * const repl = require('node:repl');
261
- *
262
- * const replServer = repl.start({ prompt: '> ' });
263
- * replServer.defineCommand('sayhello', {
264
- * help: 'Say hello',
265
- * action(name) {
266
- * this.clearBufferedCommand();
267
- * console.log(`Hello, ${name}!`);
268
- * this.displayPrompt();
269
- * },
270
- * });
271
- * replServer.defineCommand('saybye', function saybye() {
272
- * console.log('Goodbye!');
273
- * this.close();
274
- * });
275
- * ```
276
- *
277
- * The new commands can then be used from within the REPL instance:
278
- *
279
- * ```console
280
- * > .sayhello Node.js User
281
- * Hello, Node.js User!
282
- * > .saybye
283
- * Goodbye!
284
- * ```
285
- * @since v0.3.0
286
- * @param keyword The command keyword (_without_ a leading `.` character).
287
- * @param cmd The function to invoke when the command is processed.
288
- */
289
- defineCommand(keyword: string, cmd: REPLCommandAction | REPLCommand): void;
290
- /**
291
- * The `replServer.displayPrompt()` method readies the REPL instance for input
292
- * from the user, printing the configured `prompt` to a new line in the `output`and resuming the `input` to accept new input.
293
- *
294
- * When multi-line input is being entered, an ellipsis is printed rather than the
295
- * 'prompt'.
296
- *
297
- * When `preserveCursor` is `true`, the cursor placement will not be reset to `0`.
298
- *
299
- * The `replServer.displayPrompt` method is primarily intended to be called from
300
- * within the action function for commands registered using the`replServer.defineCommand()` method.
301
- * @since v0.1.91
302
- */
303
- displayPrompt(preserveCursor?: boolean): void;
304
- /**
305
- * The `replServer.clearBufferedCommand()` method clears any command that has been
306
- * buffered but not yet executed. This method is primarily intended to be
307
- * called from within the action function for commands registered using the`replServer.defineCommand()` method.
308
- * @since v9.0.0
309
- */
310
- clearBufferedCommand(): void;
311
- /**
312
- * Initializes a history log file for the REPL instance. When executing the
313
- * Node.js binary and using the command-line REPL, a history file is initialized
314
- * by default. However, this is not the case when creating a REPL
315
- * programmatically. Use this method to initialize a history log file when working
316
- * with REPL instances programmatically.
317
- * @since v11.10.0
318
- * @param historyPath the path to the history file
319
- * @param callback called when history writes are ready or upon error
320
- */
321
- setupHistory(path: string, callback: (err: Error | null, repl: this) => void): void;
322
- /**
323
- * events.EventEmitter
324
- * 1. close - inherited from `readline.Interface`
325
- * 2. line - inherited from `readline.Interface`
326
- * 3. pause - inherited from `readline.Interface`
327
- * 4. resume - inherited from `readline.Interface`
328
- * 5. SIGCONT - inherited from `readline.Interface`
329
- * 6. SIGINT - inherited from `readline.Interface`
330
- * 7. SIGTSTP - inherited from `readline.Interface`
331
- * 8. exit
332
- * 9. reset
333
- */
334
- addListener(event: string, listener: (...args: any[]) => void): this;
335
- addListener(event: "close", listener: () => void): this;
336
- addListener(event: "line", listener: (input: string) => void): this;
337
- addListener(event: "pause", listener: () => void): this;
338
- addListener(event: "resume", listener: () => void): this;
339
- addListener(event: "SIGCONT", listener: () => void): this;
340
- addListener(event: "SIGINT", listener: () => void): this;
341
- addListener(event: "SIGTSTP", listener: () => void): this;
342
- addListener(event: "exit", listener: () => void): this;
343
- addListener(event: "reset", listener: (context: Context) => void): this;
344
- emit(event: string | symbol, ...args: any[]): boolean;
345
- emit(event: "close"): boolean;
346
- emit(event: "line", input: string): boolean;
347
- emit(event: "pause"): boolean;
348
- emit(event: "resume"): boolean;
349
- emit(event: "SIGCONT"): boolean;
350
- emit(event: "SIGINT"): boolean;
351
- emit(event: "SIGTSTP"): boolean;
352
- emit(event: "exit"): boolean;
353
- emit(event: "reset", context: Context): boolean;
354
- on(event: string, listener: (...args: any[]) => void): this;
355
- on(event: "close", listener: () => void): this;
356
- on(event: "line", listener: (input: string) => void): this;
357
- on(event: "pause", listener: () => void): this;
358
- on(event: "resume", listener: () => void): this;
359
- on(event: "SIGCONT", listener: () => void): this;
360
- on(event: "SIGINT", listener: () => void): this;
361
- on(event: "SIGTSTP", listener: () => void): this;
362
- on(event: "exit", listener: () => void): this;
363
- on(event: "reset", listener: (context: Context) => void): this;
364
- once(event: string, listener: (...args: any[]) => void): this;
365
- once(event: "close", listener: () => void): this;
366
- once(event: "line", listener: (input: string) => void): this;
367
- once(event: "pause", listener: () => void): this;
368
- once(event: "resume", listener: () => void): this;
369
- once(event: "SIGCONT", listener: () => void): this;
370
- once(event: "SIGINT", listener: () => void): this;
371
- once(event: "SIGTSTP", listener: () => void): this;
372
- once(event: "exit", listener: () => void): this;
373
- once(event: "reset", listener: (context: Context) => void): this;
374
- prependListener(event: string, listener: (...args: any[]) => void): this;
375
- prependListener(event: "close", listener: () => void): this;
376
- prependListener(event: "line", listener: (input: string) => void): this;
377
- prependListener(event: "pause", listener: () => void): this;
378
- prependListener(event: "resume", listener: () => void): this;
379
- prependListener(event: "SIGCONT", listener: () => void): this;
380
- prependListener(event: "SIGINT", listener: () => void): this;
381
- prependListener(event: "SIGTSTP", listener: () => void): this;
382
- prependListener(event: "exit", listener: () => void): this;
383
- prependListener(event: "reset", listener: (context: Context) => void): this;
384
- prependOnceListener(event: string, listener: (...args: any[]) => void): this;
385
- prependOnceListener(event: "close", listener: () => void): this;
386
- prependOnceListener(event: "line", listener: (input: string) => void): this;
387
- prependOnceListener(event: "pause", listener: () => void): this;
388
- prependOnceListener(event: "resume", listener: () => void): this;
389
- prependOnceListener(event: "SIGCONT", listener: () => void): this;
390
- prependOnceListener(event: "SIGINT", listener: () => void): this;
391
- prependOnceListener(event: "SIGTSTP", listener: () => void): this;
392
- prependOnceListener(event: "exit", listener: () => void): this;
393
- prependOnceListener(event: "reset", listener: (context: Context) => void): this;
394
- }
395
- /**
396
- * A flag passed in the REPL options. Evaluates expressions in sloppy mode.
397
- */
398
- const REPL_MODE_SLOPPY: unique symbol;
399
- /**
400
- * A flag passed in the REPL options. Evaluates expressions in strict mode.
401
- * This is equivalent to prefacing every repl statement with `'use strict'`.
402
- */
403
- const REPL_MODE_STRICT: unique symbol;
404
- /**
405
- * The `repl.start()` method creates and starts a {@link REPLServer} instance.
406
- *
407
- * If `options` is a string, then it specifies the input prompt:
408
- *
409
- * ```js
410
- * const repl = require('node:repl');
411
- *
412
- * // a Unix style prompt
413
- * repl.start('$ ');
414
- * ```
415
- * @since v0.1.91
416
- */
417
- function start(options?: string | ReplOptions): REPLServer;
418
- /**
419
- * Indicates a recoverable error that a `REPLServer` can use to support multi-line input.
420
- *
421
- * @see https://nodejs.org/dist/latest-v20.x/docs/api/repl.html#repl_recoverable_errors
422
- */
423
- class Recoverable extends SyntaxError {
424
- err: Error;
425
- constructor(err: Error);
426
- }
427
- }
428
- declare module "node:repl" {
429
- export * from "repl";
430
- }
@@ -1,12 +0,0 @@
1
- declare module "stream/consumers" {
2
- import { Blob as NodeBlob } from "node:buffer";
3
- import { Readable } from "node:stream";
4
- function buffer(stream: NodeJS.ReadableStream | Readable | AsyncIterable<any>): Promise<Buffer>;
5
- function text(stream: NodeJS.ReadableStream | Readable | AsyncIterable<any>): Promise<string>;
6
- function arrayBuffer(stream: NodeJS.ReadableStream | Readable | AsyncIterable<any>): Promise<ArrayBuffer>;
7
- function blob(stream: NodeJS.ReadableStream | Readable | AsyncIterable<any>): Promise<NodeBlob>;
8
- function json(stream: NodeJS.ReadableStream | Readable | AsyncIterable<any>): Promise<unknown>;
9
- }
10
- declare module "node:stream/consumers" {
11
- export * from "stream/consumers";
12
- }
@@ -1,83 +0,0 @@
1
- declare module "stream/promises" {
2
- import {
3
- FinishedOptions,
4
- PipelineDestination,
5
- PipelineOptions,
6
- PipelinePromise,
7
- PipelineSource,
8
- PipelineTransform,
9
- } from "node:stream";
10
- function finished(
11
- stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream,
12
- options?: FinishedOptions,
13
- ): Promise<void>;
14
- function pipeline<A extends PipelineSource<any>, B extends PipelineDestination<A, any>>(
15
- source: A,
16
- destination: B,
17
- options?: PipelineOptions,
18
- ): PipelinePromise<B>;
19
- function pipeline<
20
- A extends PipelineSource<any>,
21
- T1 extends PipelineTransform<A, any>,
22
- B extends PipelineDestination<T1, any>,
23
- >(
24
- source: A,
25
- transform1: T1,
26
- destination: B,
27
- options?: PipelineOptions,
28
- ): PipelinePromise<B>;
29
- function pipeline<
30
- A extends PipelineSource<any>,
31
- T1 extends PipelineTransform<A, any>,
32
- T2 extends PipelineTransform<T1, any>,
33
- B extends PipelineDestination<T2, any>,
34
- >(
35
- source: A,
36
- transform1: T1,
37
- transform2: T2,
38
- destination: B,
39
- options?: PipelineOptions,
40
- ): PipelinePromise<B>;
41
- function pipeline<
42
- A extends PipelineSource<any>,
43
- T1 extends PipelineTransform<A, any>,
44
- T2 extends PipelineTransform<T1, any>,
45
- T3 extends PipelineTransform<T2, any>,
46
- B extends PipelineDestination<T3, any>,
47
- >(
48
- source: A,
49
- transform1: T1,
50
- transform2: T2,
51
- transform3: T3,
52
- destination: B,
53
- options?: PipelineOptions,
54
- ): PipelinePromise<B>;
55
- function pipeline<
56
- A extends PipelineSource<any>,
57
- T1 extends PipelineTransform<A, any>,
58
- T2 extends PipelineTransform<T1, any>,
59
- T3 extends PipelineTransform<T2, any>,
60
- T4 extends PipelineTransform<T3, any>,
61
- B extends PipelineDestination<T4, any>,
62
- >(
63
- source: A,
64
- transform1: T1,
65
- transform2: T2,
66
- transform3: T3,
67
- transform4: T4,
68
- destination: B,
69
- options?: PipelineOptions,
70
- ): PipelinePromise<B>;
71
- function pipeline(
72
- streams: ReadonlyArray<NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream>,
73
- options?: PipelineOptions,
74
- ): Promise<void>;
75
- function pipeline(
76
- stream1: NodeJS.ReadableStream,
77
- stream2: NodeJS.ReadWriteStream | NodeJS.WritableStream,
78
- ...streams: Array<NodeJS.ReadWriteStream | NodeJS.WritableStream | PipelineOptions>
79
- ): Promise<void>;
80
- }
81
- declare module "node:stream/promises" {
82
- export * from "stream/promises";
83
- }