@alanszp/jwt 12.0.0 → 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 (155) hide show
  1. package/babel.config.js +7 -0
  2. package/dist/BitmaskUtils.d.ts +48 -0
  3. package/dist/BitmaskUtils.js +64 -0
  4. package/dist/BitmaskUtils.js.map +1 -0
  5. package/dist/BitmaskUtils.test.d.ts +1 -0
  6. package/dist/BitmaskUtils.test.js +152 -0
  7. package/dist/BitmaskUtils.test.js.map +1 -0
  8. package/dist/JWTUser.d.ts +58 -2
  9. package/dist/JWTUser.js +158 -3
  10. package/dist/JWTUser.js.map +1 -1
  11. package/dist/PermissionService.d.ts +26 -0
  12. package/dist/PermissionService.js +108 -0
  13. package/dist/PermissionService.js.map +1 -0
  14. package/dist/axiosPermissionsResolutionFactory.d.ts +4 -0
  15. package/dist/axiosPermissionsResolutionFactory.js +52 -0
  16. package/dist/axiosPermissionsResolutionFactory.js.map +1 -0
  17. package/dist/errors/NoPermissionError.d.ts +7 -0
  18. package/dist/errors/NoPermissionError.js +20 -0
  19. package/dist/errors/NoPermissionError.js.map +1 -0
  20. package/dist/errors/PermissionNotFound.d.ts +9 -0
  21. package/dist/errors/PermissionNotFound.js +24 -0
  22. package/dist/errors/PermissionNotFound.js.map +1 -0
  23. package/dist/errors/PermissionServiceError.d.ts +3 -0
  24. package/dist/errors/PermissionServiceError.js +8 -0
  25. package/dist/errors/PermissionServiceError.js.map +1 -0
  26. package/dist/errors/PermissionServiceNotInstantiated.d.ts +7 -0
  27. package/dist/errors/PermissionServiceNotInstantiated.js +17 -0
  28. package/dist/errors/PermissionServiceNotInstantiated.js.map +1 -0
  29. package/dist/errors/PermissionServiceRequestError.d.ts +9 -0
  30. package/dist/errors/PermissionServiceRequestError.js +23 -0
  31. package/dist/errors/PermissionServiceRequestError.js.map +1 -0
  32. package/dist/index.d.ts +7 -0
  33. package/dist/index.js +7 -0
  34. package/dist/index.js.map +1 -1
  35. package/dist/types.d.ts +7 -0
  36. package/jest.config.js +10 -0
  37. package/package.json +13 -5
  38. package/tsconfig.json +5 -2
  39. package/.gitignore +0 -3
  40. package/.npmignore +0 -3
  41. package/node_modules/@types/node/LICENSE +0 -21
  42. package/node_modules/@types/node/README.md +0 -15
  43. package/node_modules/@types/node/assert/strict.d.ts +0 -8
  44. package/node_modules/@types/node/assert.d.ts +0 -996
  45. package/node_modules/@types/node/async_hooks.d.ts +0 -539
  46. package/node_modules/@types/node/buffer.d.ts +0 -2362
  47. package/node_modules/@types/node/child_process.d.ts +0 -1540
  48. package/node_modules/@types/node/cluster.d.ts +0 -432
  49. package/node_modules/@types/node/console.d.ts +0 -415
  50. package/node_modules/@types/node/constants.d.ts +0 -19
  51. package/node_modules/@types/node/crypto.d.ts +0 -4487
  52. package/node_modules/@types/node/dgram.d.ts +0 -596
  53. package/node_modules/@types/node/diagnostics_channel.d.ts +0 -545
  54. package/node_modules/@types/node/dns/promises.d.ts +0 -425
  55. package/node_modules/@types/node/dns.d.ts +0 -809
  56. package/node_modules/@types/node/dom-events.d.ts +0 -122
  57. package/node_modules/@types/node/domain.d.ts +0 -170
  58. package/node_modules/@types/node/events.d.ts +0 -879
  59. package/node_modules/@types/node/fs/promises.d.ts +0 -1239
  60. package/node_modules/@types/node/fs.d.ts +0 -4311
  61. package/node_modules/@types/node/globals.d.ts +0 -411
  62. package/node_modules/@types/node/globals.global.d.ts +0 -1
  63. package/node_modules/@types/node/http.d.ts +0 -1887
  64. package/node_modules/@types/node/http2.d.ts +0 -2382
  65. package/node_modules/@types/node/https.d.ts +0 -550
  66. package/node_modules/@types/node/index.d.ts +0 -88
  67. package/node_modules/@types/node/inspector.d.ts +0 -2747
  68. package/node_modules/@types/node/module.d.ts +0 -315
  69. package/node_modules/@types/node/net.d.ts +0 -949
  70. package/node_modules/@types/node/os.d.ts +0 -478
  71. package/node_modules/@types/node/package.json +0 -229
  72. package/node_modules/@types/node/path.d.ts +0 -191
  73. package/node_modules/@types/node/perf_hooks.d.ts +0 -645
  74. package/node_modules/@types/node/process.d.ts +0 -1561
  75. package/node_modules/@types/node/punycode.d.ts +0 -117
  76. package/node_modules/@types/node/querystring.d.ts +0 -141
  77. package/node_modules/@types/node/readline/promises.d.ts +0 -150
  78. package/node_modules/@types/node/readline.d.ts +0 -539
  79. package/node_modules/@types/node/repl.d.ts +0 -430
  80. package/node_modules/@types/node/stream/consumers.d.ts +0 -12
  81. package/node_modules/@types/node/stream/promises.d.ts +0 -83
  82. package/node_modules/@types/node/stream/web.d.ts +0 -366
  83. package/node_modules/@types/node/stream.d.ts +0 -1701
  84. package/node_modules/@types/node/string_decoder.d.ts +0 -67
  85. package/node_modules/@types/node/test.d.ts +0 -1465
  86. package/node_modules/@types/node/timers/promises.d.ts +0 -93
  87. package/node_modules/@types/node/timers.d.ts +0 -240
  88. package/node_modules/@types/node/tls.d.ts +0 -1210
  89. package/node_modules/@types/node/trace_events.d.ts +0 -182
  90. package/node_modules/@types/node/ts4.8/assert/strict.d.ts +0 -8
  91. package/node_modules/@types/node/ts4.8/assert.d.ts +0 -996
  92. package/node_modules/@types/node/ts4.8/async_hooks.d.ts +0 -539
  93. package/node_modules/@types/node/ts4.8/buffer.d.ts +0 -2362
  94. package/node_modules/@types/node/ts4.8/child_process.d.ts +0 -1540
  95. package/node_modules/@types/node/ts4.8/cluster.d.ts +0 -432
  96. package/node_modules/@types/node/ts4.8/console.d.ts +0 -415
  97. package/node_modules/@types/node/ts4.8/constants.d.ts +0 -19
  98. package/node_modules/@types/node/ts4.8/crypto.d.ts +0 -4487
  99. package/node_modules/@types/node/ts4.8/dgram.d.ts +0 -596
  100. package/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +0 -545
  101. package/node_modules/@types/node/ts4.8/dns/promises.d.ts +0 -425
  102. package/node_modules/@types/node/ts4.8/dns.d.ts +0 -809
  103. package/node_modules/@types/node/ts4.8/dom-events.d.ts +0 -122
  104. package/node_modules/@types/node/ts4.8/domain.d.ts +0 -170
  105. package/node_modules/@types/node/ts4.8/events.d.ts +0 -879
  106. package/node_modules/@types/node/ts4.8/fs/promises.d.ts +0 -1239
  107. package/node_modules/@types/node/ts4.8/fs.d.ts +0 -4311
  108. package/node_modules/@types/node/ts4.8/globals.d.ts +0 -411
  109. package/node_modules/@types/node/ts4.8/globals.global.d.ts +0 -1
  110. package/node_modules/@types/node/ts4.8/http.d.ts +0 -1887
  111. package/node_modules/@types/node/ts4.8/http2.d.ts +0 -2382
  112. package/node_modules/@types/node/ts4.8/https.d.ts +0 -550
  113. package/node_modules/@types/node/ts4.8/index.d.ts +0 -88
  114. package/node_modules/@types/node/ts4.8/inspector.d.ts +0 -2747
  115. package/node_modules/@types/node/ts4.8/module.d.ts +0 -315
  116. package/node_modules/@types/node/ts4.8/net.d.ts +0 -949
  117. package/node_modules/@types/node/ts4.8/os.d.ts +0 -478
  118. package/node_modules/@types/node/ts4.8/path.d.ts +0 -191
  119. package/node_modules/@types/node/ts4.8/perf_hooks.d.ts +0 -645
  120. package/node_modules/@types/node/ts4.8/process.d.ts +0 -1561
  121. package/node_modules/@types/node/ts4.8/punycode.d.ts +0 -117
  122. package/node_modules/@types/node/ts4.8/querystring.d.ts +0 -141
  123. package/node_modules/@types/node/ts4.8/readline/promises.d.ts +0 -150
  124. package/node_modules/@types/node/ts4.8/readline.d.ts +0 -539
  125. package/node_modules/@types/node/ts4.8/repl.d.ts +0 -430
  126. package/node_modules/@types/node/ts4.8/stream/consumers.d.ts +0 -12
  127. package/node_modules/@types/node/ts4.8/stream/promises.d.ts +0 -83
  128. package/node_modules/@types/node/ts4.8/stream/web.d.ts +0 -366
  129. package/node_modules/@types/node/ts4.8/stream.d.ts +0 -1701
  130. package/node_modules/@types/node/ts4.8/string_decoder.d.ts +0 -67
  131. package/node_modules/@types/node/ts4.8/test.d.ts +0 -1465
  132. package/node_modules/@types/node/ts4.8/timers/promises.d.ts +0 -93
  133. package/node_modules/@types/node/ts4.8/timers.d.ts +0 -240
  134. package/node_modules/@types/node/ts4.8/tls.d.ts +0 -1210
  135. package/node_modules/@types/node/ts4.8/trace_events.d.ts +0 -182
  136. package/node_modules/@types/node/ts4.8/tty.d.ts +0 -208
  137. package/node_modules/@types/node/ts4.8/url.d.ts +0 -927
  138. package/node_modules/@types/node/ts4.8/util.d.ts +0 -2183
  139. package/node_modules/@types/node/ts4.8/v8.d.ts +0 -764
  140. package/node_modules/@types/node/ts4.8/vm.d.ts +0 -903
  141. package/node_modules/@types/node/ts4.8/wasi.d.ts +0 -179
  142. package/node_modules/@types/node/ts4.8/worker_threads.d.ts +0 -691
  143. package/node_modules/@types/node/ts4.8/zlib.d.ts +0 -517
  144. package/node_modules/@types/node/tty.d.ts +0 -208
  145. package/node_modules/@types/node/url.d.ts +0 -927
  146. package/node_modules/@types/node/util.d.ts +0 -2183
  147. package/node_modules/@types/node/v8.d.ts +0 -764
  148. package/node_modules/@types/node/vm.d.ts +0 -903
  149. package/node_modules/@types/node/wasi.d.ts +0 -179
  150. package/node_modules/@types/node/worker_threads.d.ts +0 -691
  151. package/node_modules/@types/node/zlib.d.ts +0 -517
  152. package/src/JWTUser.ts +0 -85
  153. package/src/index.ts +0 -3
  154. package/src/jwt.ts +0 -81
  155. package/src/types.ts +0 -31
@@ -1,415 +0,0 @@
1
- /**
2
- * The `node:console` module provides a simple debugging console that is similar to
3
- * the JavaScript console mechanism provided by web browsers.
4
- *
5
- * The module exports two specific components:
6
- *
7
- * * A `Console` class with methods such as `console.log()`, `console.error()`, and`console.warn()` that can be used to write to any Node.js stream.
8
- * * A global `console` instance configured to write to `process.stdout` and `process.stderr`. The global `console` can be used without calling`require('node:console')`.
9
- *
10
- * _**Warning**_: The global console object's methods are neither consistently
11
- * synchronous like the browser APIs they resemble, nor are they consistently
12
- * asynchronous like all other Node.js streams. See the `note on process I/O` for
13
- * more information.
14
- *
15
- * Example using the global `console`:
16
- *
17
- * ```js
18
- * console.log('hello world');
19
- * // Prints: hello world, to stdout
20
- * console.log('hello %s', 'world');
21
- * // Prints: hello world, to stdout
22
- * console.error(new Error('Whoops, something bad happened'));
23
- * // Prints error message and stack trace to stderr:
24
- * // Error: Whoops, something bad happened
25
- * // at [eval]:5:15
26
- * // at Script.runInThisContext (node:vm:132:18)
27
- * // at Object.runInThisContext (node:vm:309:38)
28
- * // at node:internal/process/execution:77:19
29
- * // at [eval]-wrapper:6:22
30
- * // at evalScript (node:internal/process/execution:76:60)
31
- * // at node:internal/main/eval_string:23:3
32
- *
33
- * const name = 'Will Robinson';
34
- * console.warn(`Danger ${name}! Danger!`);
35
- * // Prints: Danger Will Robinson! Danger!, to stderr
36
- * ```
37
- *
38
- * Example using the `Console` class:
39
- *
40
- * ```js
41
- * const out = getStreamSomehow();
42
- * const err = getStreamSomehow();
43
- * const myConsole = new console.Console(out, err);
44
- *
45
- * myConsole.log('hello world');
46
- * // Prints: hello world, to out
47
- * myConsole.log('hello %s', 'world');
48
- * // Prints: hello world, to out
49
- * myConsole.error(new Error('Whoops, something bad happened'));
50
- * // Prints: [Error: Whoops, something bad happened], to err
51
- *
52
- * const name = 'Will Robinson';
53
- * myConsole.warn(`Danger ${name}! Danger!`);
54
- * // Prints: Danger Will Robinson! Danger!, to err
55
- * ```
56
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/console.js)
57
- */
58
- declare module "console" {
59
- import console = require("node:console");
60
- export = console;
61
- }
62
- declare module "node:console" {
63
- import { InspectOptions } from "node:util";
64
- global {
65
- // This needs to be global to avoid TS2403 in case lib.dom.d.ts is present in the same build
66
- interface Console {
67
- Console: console.ConsoleConstructor;
68
- /**
69
- * `console.assert()` writes a message if `value` is [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy) or omitted. It only
70
- * writes a message and does not otherwise affect execution. The output always
71
- * starts with `"Assertion failed"`. If provided, `message` is formatted using `util.format()`.
72
- *
73
- * If `value` is [truthy](https://developer.mozilla.org/en-US/docs/Glossary/Truthy), nothing happens.
74
- *
75
- * ```js
76
- * console.assert(true, 'does nothing');
77
- *
78
- * console.assert(false, 'Whoops %s work', 'didn\'t');
79
- * // Assertion failed: Whoops didn't work
80
- *
81
- * console.assert();
82
- * // Assertion failed
83
- * ```
84
- * @since v0.1.101
85
- * @param value The value tested for being truthy.
86
- * @param message All arguments besides `value` are used as error message.
87
- */
88
- assert(value: any, message?: string, ...optionalParams: any[]): void;
89
- /**
90
- * When `stdout` is a TTY, calling `console.clear()` will attempt to clear the
91
- * TTY. When `stdout` is not a TTY, this method does nothing.
92
- *
93
- * The specific operation of `console.clear()` can vary across operating systems
94
- * and terminal types. For most Linux operating systems, `console.clear()`operates similarly to the `clear` shell command. On Windows, `console.clear()`will clear only the output in the
95
- * current terminal viewport for the Node.js
96
- * binary.
97
- * @since v8.3.0
98
- */
99
- clear(): void;
100
- /**
101
- * Maintains an internal counter specific to `label` and outputs to `stdout` the
102
- * number of times `console.count()` has been called with the given `label`.
103
- *
104
- * ```js
105
- * > console.count()
106
- * default: 1
107
- * undefined
108
- * > console.count('default')
109
- * default: 2
110
- * undefined
111
- * > console.count('abc')
112
- * abc: 1
113
- * undefined
114
- * > console.count('xyz')
115
- * xyz: 1
116
- * undefined
117
- * > console.count('abc')
118
- * abc: 2
119
- * undefined
120
- * > console.count()
121
- * default: 3
122
- * undefined
123
- * >
124
- * ```
125
- * @since v8.3.0
126
- * @param [label='default'] The display label for the counter.
127
- */
128
- count(label?: string): void;
129
- /**
130
- * Resets the internal counter specific to `label`.
131
- *
132
- * ```js
133
- * > console.count('abc');
134
- * abc: 1
135
- * undefined
136
- * > console.countReset('abc');
137
- * undefined
138
- * > console.count('abc');
139
- * abc: 1
140
- * undefined
141
- * >
142
- * ```
143
- * @since v8.3.0
144
- * @param [label='default'] The display label for the counter.
145
- */
146
- countReset(label?: string): void;
147
- /**
148
- * The `console.debug()` function is an alias for {@link log}.
149
- * @since v8.0.0
150
- */
151
- debug(message?: any, ...optionalParams: any[]): void;
152
- /**
153
- * Uses `util.inspect()` on `obj` and prints the resulting string to `stdout`.
154
- * This function bypasses any custom `inspect()` function defined on `obj`.
155
- * @since v0.1.101
156
- */
157
- dir(obj: any, options?: InspectOptions): void;
158
- /**
159
- * This method calls `console.log()` passing it the arguments received.
160
- * This method does not produce any XML formatting.
161
- * @since v8.0.0
162
- */
163
- dirxml(...data: any[]): void;
164
- /**
165
- * Prints to `stderr` with newline. Multiple arguments can be passed, with the
166
- * first used as the primary message and all additional used as substitution
167
- * values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html) (the arguments are all passed to `util.format()`).
168
- *
169
- * ```js
170
- * const code = 5;
171
- * console.error('error #%d', code);
172
- * // Prints: error #5, to stderr
173
- * console.error('error', code);
174
- * // Prints: error 5, to stderr
175
- * ```
176
- *
177
- * If formatting elements (e.g. `%d`) are not found in the first string then `util.inspect()` is called on each argument and the resulting string
178
- * values are concatenated. See `util.format()` for more information.
179
- * @since v0.1.100
180
- */
181
- error(message?: any, ...optionalParams: any[]): void;
182
- /**
183
- * Increases indentation of subsequent lines by spaces for `groupIndentation`length.
184
- *
185
- * If one or more `label`s are provided, those are printed first without the
186
- * additional indentation.
187
- * @since v8.5.0
188
- */
189
- group(...label: any[]): void;
190
- /**
191
- * An alias for {@link group}.
192
- * @since v8.5.0
193
- */
194
- groupCollapsed(...label: any[]): void;
195
- /**
196
- * Decreases indentation of subsequent lines by spaces for `groupIndentation`length.
197
- * @since v8.5.0
198
- */
199
- groupEnd(): void;
200
- /**
201
- * The `console.info()` function is an alias for {@link log}.
202
- * @since v0.1.100
203
- */
204
- info(message?: any, ...optionalParams: any[]): void;
205
- /**
206
- * Prints to `stdout` with newline. Multiple arguments can be passed, with the
207
- * first used as the primary message and all additional used as substitution
208
- * values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html) (the arguments are all passed to `util.format()`).
209
- *
210
- * ```js
211
- * const count = 5;
212
- * console.log('count: %d', count);
213
- * // Prints: count: 5, to stdout
214
- * console.log('count:', count);
215
- * // Prints: count: 5, to stdout
216
- * ```
217
- *
218
- * See `util.format()` for more information.
219
- * @since v0.1.100
220
- */
221
- log(message?: any, ...optionalParams: any[]): void;
222
- /**
223
- * Try to construct a table with the columns of the properties of `tabularData`(or use `properties`) and rows of `tabularData` and log it. Falls back to just
224
- * logging the argument if it can't be parsed as tabular.
225
- *
226
- * ```js
227
- * // These can't be parsed as tabular data
228
- * console.table(Symbol());
229
- * // Symbol()
230
- *
231
- * console.table(undefined);
232
- * // undefined
233
- *
234
- * console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }]);
235
- * // ┌─────────┬─────┬─────┐
236
- * // │ (index) │ a │ b │
237
- * // ├─────────┼─────┼─────┤
238
- * // │ 0 │ 1 │ 'Y' │
239
- * // │ 1 │ 'Z' │ 2 │
240
- * // └─────────┴─────┴─────┘
241
- *
242
- * console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }], ['a']);
243
- * // ┌─────────┬─────┐
244
- * // │ (index) │ a │
245
- * // ├─────────┼─────┤
246
- * // │ 0 │ 1 │
247
- * // │ 1 │ 'Z' │
248
- * // └─────────┴─────┘
249
- * ```
250
- * @since v10.0.0
251
- * @param properties Alternate properties for constructing the table.
252
- */
253
- table(tabularData: any, properties?: readonly string[]): void;
254
- /**
255
- * Starts a timer that can be used to compute the duration of an operation. Timers
256
- * are identified by a unique `label`. Use the same `label` when calling {@link timeEnd} to stop the timer and output the elapsed time in
257
- * suitable time units to `stdout`. For example, if the elapsed
258
- * time is 3869ms, `console.timeEnd()` displays "3.869s".
259
- * @since v0.1.104
260
- * @param [label='default']
261
- */
262
- time(label?: string): void;
263
- /**
264
- * Stops a timer that was previously started by calling {@link time} and
265
- * prints the result to `stdout`:
266
- *
267
- * ```js
268
- * console.time('bunch-of-stuff');
269
- * // Do a bunch of stuff.
270
- * console.timeEnd('bunch-of-stuff');
271
- * // Prints: bunch-of-stuff: 225.438ms
272
- * ```
273
- * @since v0.1.104
274
- * @param [label='default']
275
- */
276
- timeEnd(label?: string): void;
277
- /**
278
- * For a timer that was previously started by calling {@link time}, prints
279
- * the elapsed time and other `data` arguments to `stdout`:
280
- *
281
- * ```js
282
- * console.time('process');
283
- * const value = expensiveProcess1(); // Returns 42
284
- * console.timeLog('process', value);
285
- * // Prints "process: 365.227ms 42".
286
- * doExpensiveProcess2(value);
287
- * console.timeEnd('process');
288
- * ```
289
- * @since v10.7.0
290
- * @param [label='default']
291
- */
292
- timeLog(label?: string, ...data: any[]): void;
293
- /**
294
- * Prints to `stderr` the string `'Trace: '`, followed by the `util.format()` formatted message and stack trace to the current position in the code.
295
- *
296
- * ```js
297
- * console.trace('Show me');
298
- * // Prints: (stack trace will vary based on where trace is called)
299
- * // Trace: Show me
300
- * // at repl:2:9
301
- * // at REPLServer.defaultEval (repl.js:248:27)
302
- * // at bound (domain.js:287:14)
303
- * // at REPLServer.runBound [as eval] (domain.js:300:12)
304
- * // at REPLServer.<anonymous> (repl.js:412:12)
305
- * // at emitOne (events.js:82:20)
306
- * // at REPLServer.emit (events.js:169:7)
307
- * // at REPLServer.Interface._onLine (readline.js:210:10)
308
- * // at REPLServer.Interface._line (readline.js:549:8)
309
- * // at REPLServer.Interface._ttyWrite (readline.js:826:14)
310
- * ```
311
- * @since v0.1.104
312
- */
313
- trace(message?: any, ...optionalParams: any[]): void;
314
- /**
315
- * The `console.warn()` function is an alias for {@link error}.
316
- * @since v0.1.100
317
- */
318
- warn(message?: any, ...optionalParams: any[]): void;
319
- // --- Inspector mode only ---
320
- /**
321
- * This method does not display anything unless used in the inspector.
322
- * Starts a JavaScript CPU profile with an optional label.
323
- */
324
- profile(label?: string): void;
325
- /**
326
- * This method does not display anything unless used in the inspector.
327
- * Stops the current JavaScript CPU profiling session if one has been started and prints the report to the Profiles panel of the inspector.
328
- */
329
- profileEnd(label?: string): void;
330
- /**
331
- * This method does not display anything unless used in the inspector.
332
- * Adds an event with the label `label` to the Timeline panel of the inspector.
333
- */
334
- timeStamp(label?: string): void;
335
- }
336
- /**
337
- * The `console` module provides a simple debugging console that is similar to the
338
- * JavaScript console mechanism provided by web browsers.
339
- *
340
- * The module exports two specific components:
341
- *
342
- * * A `Console` class with methods such as `console.log()`, `console.error()` and`console.warn()` that can be used to write to any Node.js stream.
343
- * * A global `console` instance configured to write to `process.stdout` and `process.stderr`. The global `console` can be used without calling`require('console')`.
344
- *
345
- * _**Warning**_: The global console object's methods are neither consistently
346
- * synchronous like the browser APIs they resemble, nor are they consistently
347
- * asynchronous like all other Node.js streams. See the `note on process I/O` for
348
- * more information.
349
- *
350
- * Example using the global `console`:
351
- *
352
- * ```js
353
- * console.log('hello world');
354
- * // Prints: hello world, to stdout
355
- * console.log('hello %s', 'world');
356
- * // Prints: hello world, to stdout
357
- * console.error(new Error('Whoops, something bad happened'));
358
- * // Prints error message and stack trace to stderr:
359
- * // Error: Whoops, something bad happened
360
- * // at [eval]:5:15
361
- * // at Script.runInThisContext (node:vm:132:18)
362
- * // at Object.runInThisContext (node:vm:309:38)
363
- * // at node:internal/process/execution:77:19
364
- * // at [eval]-wrapper:6:22
365
- * // at evalScript (node:internal/process/execution:76:60)
366
- * // at node:internal/main/eval_string:23:3
367
- *
368
- * const name = 'Will Robinson';
369
- * console.warn(`Danger ${name}! Danger!`);
370
- * // Prints: Danger Will Robinson! Danger!, to stderr
371
- * ```
372
- *
373
- * Example using the `Console` class:
374
- *
375
- * ```js
376
- * const out = getStreamSomehow();
377
- * const err = getStreamSomehow();
378
- * const myConsole = new console.Console(out, err);
379
- *
380
- * myConsole.log('hello world');
381
- * // Prints: hello world, to out
382
- * myConsole.log('hello %s', 'world');
383
- * // Prints: hello world, to out
384
- * myConsole.error(new Error('Whoops, something bad happened'));
385
- * // Prints: [Error: Whoops, something bad happened], to err
386
- *
387
- * const name = 'Will Robinson';
388
- * myConsole.warn(`Danger ${name}! Danger!`);
389
- * // Prints: Danger Will Robinson! Danger!, to err
390
- * ```
391
- * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/console.js)
392
- */
393
- namespace console {
394
- interface ConsoleConstructorOptions {
395
- stdout: NodeJS.WritableStream;
396
- stderr?: NodeJS.WritableStream | undefined;
397
- ignoreErrors?: boolean | undefined;
398
- colorMode?: boolean | "auto" | undefined;
399
- inspectOptions?: InspectOptions | undefined;
400
- /**
401
- * Set group indentation
402
- * @default 2
403
- */
404
- groupIndentation?: number | undefined;
405
- }
406
- interface ConsoleConstructor {
407
- prototype: Console;
408
- new(stdout: NodeJS.WritableStream, stderr?: NodeJS.WritableStream, ignoreErrors?: boolean): Console;
409
- new(options: ConsoleConstructorOptions): Console;
410
- }
411
- }
412
- var console: Console;
413
- }
414
- export = globalThis.console;
415
- }
@@ -1,19 +0,0 @@
1
- /** @deprecated since v6.3.0 - use constants property exposed by the relevant module instead. */
2
- declare module "constants" {
3
- import { constants as osConstants, SignalConstants } from "node:os";
4
- import { constants as cryptoConstants } from "node:crypto";
5
- import { constants as fsConstants } from "node:fs";
6
-
7
- const exp:
8
- & typeof osConstants.errno
9
- & typeof osConstants.priority
10
- & SignalConstants
11
- & typeof cryptoConstants
12
- & typeof fsConstants;
13
- export = exp;
14
- }
15
-
16
- declare module "node:constants" {
17
- import constants = require("constants");
18
- export = constants;
19
- }