@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,182 +0,0 @@
1
- /**
2
- * The `node:trace_events` module provides a mechanism to centralize tracing
3
- * information generated by V8, Node.js core, and userspace code.
4
- *
5
- * Tracing can be enabled with the `--trace-event-categories` command-line flag
6
- * or by using the `node:trace_events` module. The `--trace-event-categories` flag
7
- * accepts a list of comma-separated category names.
8
- *
9
- * The available categories are:
10
- *
11
- * * `node`: An empty placeholder.
12
- * * `node.async_hooks`: Enables capture of detailed `async_hooks` trace data.
13
- * The `async_hooks` events have a unique `asyncId` and a special `triggerId` `triggerAsyncId` property.
14
- * * `node.bootstrap`: Enables capture of Node.js bootstrap milestones.
15
- * * `node.console`: Enables capture of `console.time()` and `console.count()`output.
16
- * * `node.threadpoolwork.sync`: Enables capture of trace data for threadpool
17
- * synchronous operations, such as `blob`, `zlib`, `crypto` and `node_api`.
18
- * * `node.threadpoolwork.async`: Enables capture of trace data for threadpool
19
- * asynchronous operations, such as `blob`, `zlib`, `crypto` and `node_api`.
20
- * * `node.dns.native`: Enables capture of trace data for DNS queries.
21
- * * `node.net.native`: Enables capture of trace data for network.
22
- * * `node.environment`: Enables capture of Node.js Environment milestones.
23
- * * `node.fs.sync`: Enables capture of trace data for file system sync methods.
24
- * * `node.fs_dir.sync`: Enables capture of trace data for file system sync
25
- * directory methods.
26
- * * `node.fs.async`: Enables capture of trace data for file system async methods.
27
- * * `node.fs_dir.async`: Enables capture of trace data for file system async
28
- * directory methods.
29
- * * `node.perf`: Enables capture of `Performance API` measurements.
30
- * * `node.perf.usertiming`: Enables capture of only Performance API User Timing
31
- * measures and marks.
32
- * * `node.perf.timerify`: Enables capture of only Performance API timerify
33
- * measurements.
34
- * * `node.promises.rejections`: Enables capture of trace data tracking the number
35
- * of unhandled Promise rejections and handled-after-rejections.
36
- * * `node.vm.script`: Enables capture of trace data for the `node:vm` module's`runInNewContext()`, `runInContext()`, and `runInThisContext()` methods.
37
- * * `v8`: The `V8` events are GC, compiling, and execution related.
38
- * * `node.http`: Enables capture of trace data for http request / response.
39
- *
40
- * By default the `node`, `node.async_hooks`, and `v8` categories are enabled.
41
- *
42
- * ```bash
43
- * node --trace-event-categories v8,node,node.async_hooks server.js
44
- * ```
45
- *
46
- * Prior versions of Node.js required the use of the `--trace-events-enabled`flag to enable trace events. This requirement has been removed. However, the`--trace-events-enabled` flag _may_ still be
47
- * used and will enable the`node`, `node.async_hooks`, and `v8` trace event categories by default.
48
- *
49
- * ```bash
50
- * node --trace-events-enabled
51
- *
52
- * # is equivalent to
53
- *
54
- * node --trace-event-categories v8,node,node.async_hooks
55
- * ```
56
- *
57
- * Alternatively, trace events may be enabled using the `node:trace_events` module:
58
- *
59
- * ```js
60
- * const trace_events = require('node:trace_events');
61
- * const tracing = trace_events.createTracing({ categories: ['node.perf'] });
62
- * tracing.enable(); // Enable trace event capture for the 'node.perf' category
63
- *
64
- * // do work
65
- *
66
- * tracing.disable(); // Disable trace event capture for the 'node.perf' category
67
- * ```
68
- *
69
- * Running Node.js with tracing enabled will produce log files that can be opened
70
- * in the [`chrome://tracing`](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) tab of Chrome.
71
- *
72
- * The logging file is by default called `node_trace.${rotation}.log`, where`${rotation}` is an incrementing log-rotation id. The filepath pattern can
73
- * be specified with `--trace-event-file-pattern` that accepts a template
74
- * string that supports `${rotation}` and `${pid}`:
75
- *
76
- * ```bash
77
- * node --trace-event-categories v8 --trace-event-file-pattern '${pid}-${rotation}.log' server.js
78
- * ```
79
- *
80
- * To guarantee that the log file is properly generated after signal events like`SIGINT`, `SIGTERM`, or `SIGBREAK`, make sure to have the appropriate handlers
81
- * in your code, such as:
82
- *
83
- * ```js
84
- * process.on('SIGINT', function onSigint() {
85
- * console.info('Received SIGINT.');
86
- * process.exit(130); // Or applicable exit code depending on OS and signal
87
- * });
88
- * ```
89
- *
90
- * The tracing system uses the same time source
91
- * as the one used by `process.hrtime()`.
92
- * However the trace-event timestamps are expressed in microseconds,
93
- * unlike `process.hrtime()` which returns nanoseconds.
94
- *
95
- * The features from this module are not available in `Worker` threads.
96
- * @experimental
97
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/trace_events.js)
98
- */
99
- declare module "trace_events" {
100
- /**
101
- * The `Tracing` object is used to enable or disable tracing for sets of
102
- * categories. Instances are created using the
103
- * `trace_events.createTracing()` method.
104
- *
105
- * When created, the `Tracing` object is disabled. Calling the
106
- * `tracing.enable()` method adds the categories to the set of enabled trace
107
- * event categories. Calling `tracing.disable()` will remove the categories
108
- * from the set of enabled trace event categories.
109
- */
110
- interface Tracing {
111
- /**
112
- * A comma-separated list of the trace event categories covered by this
113
- * `Tracing` object.
114
- */
115
- readonly categories: string;
116
- /**
117
- * Disables this `Tracing` object.
118
- *
119
- * Only trace event categories _not_ covered by other enabled `Tracing`
120
- * objects and _not_ specified by the `--trace-event-categories` flag
121
- * will be disabled.
122
- */
123
- disable(): void;
124
- /**
125
- * Enables this `Tracing` object for the set of categories covered by
126
- * the `Tracing` object.
127
- */
128
- enable(): void;
129
- /**
130
- * `true` only if the `Tracing` object has been enabled.
131
- */
132
- readonly enabled: boolean;
133
- }
134
- interface CreateTracingOptions {
135
- /**
136
- * An array of trace category names. Values included in the array are
137
- * coerced to a string when possible. An error will be thrown if the
138
- * value cannot be coerced.
139
- */
140
- categories: string[];
141
- }
142
- /**
143
- * Creates and returns a `Tracing` object for the given set of `categories`.
144
- *
145
- * ```js
146
- * const trace_events = require('node:trace_events');
147
- * const categories = ['node.perf', 'node.async_hooks'];
148
- * const tracing = trace_events.createTracing({ categories });
149
- * tracing.enable();
150
- * // do stuff
151
- * tracing.disable();
152
- * ```
153
- * @since v10.0.0
154
- * @return .
155
- */
156
- function createTracing(options: CreateTracingOptions): Tracing;
157
- /**
158
- * Returns a comma-separated list of all currently-enabled trace event
159
- * categories. The current set of enabled trace event categories is determined
160
- * by the _union_ of all currently-enabled `Tracing` objects and any categories
161
- * enabled using the `--trace-event-categories` flag.
162
- *
163
- * Given the file `test.js` below, the command`node --trace-event-categories node.perf test.js` will print`'node.async_hooks,node.perf'` to the console.
164
- *
165
- * ```js
166
- * const trace_events = require('node:trace_events');
167
- * const t1 = trace_events.createTracing({ categories: ['node.async_hooks'] });
168
- * const t2 = trace_events.createTracing({ categories: ['node.perf'] });
169
- * const t3 = trace_events.createTracing({ categories: ['v8'] });
170
- *
171
- * t1.enable();
172
- * t2.enable();
173
- *
174
- * console.log(trace_events.getEnabledCategories());
175
- * ```
176
- * @since v10.0.0
177
- */
178
- function getEnabledCategories(): string | undefined;
179
- }
180
- declare module "node:trace_events" {
181
- export * from "trace_events";
182
- }
@@ -1,208 +0,0 @@
1
- /**
2
- * The `node:tty` module provides the `tty.ReadStream` and `tty.WriteStream`classes. In most cases, it will not be necessary or possible to use this module
3
- * directly. However, it can be accessed using:
4
- *
5
- * ```js
6
- * const tty = require('node:tty');
7
- * ```
8
- *
9
- * When Node.js detects that it is being run with a text terminal ("TTY")
10
- * attached, `process.stdin` will, by default, be initialized as an instance of`tty.ReadStream` and both `process.stdout` and `process.stderr` will, by
11
- * default, be instances of `tty.WriteStream`. The preferred method of determining
12
- * whether Node.js is being run within a TTY context is to check that the value of
13
- * the `process.stdout.isTTY` property is `true`:
14
- *
15
- * ```console
16
- * $ node -p -e "Boolean(process.stdout.isTTY)"
17
- * true
18
- * $ node -p -e "Boolean(process.stdout.isTTY)" | cat
19
- * false
20
- * ```
21
- *
22
- * In most cases, there should be little to no reason for an application to
23
- * manually create instances of the `tty.ReadStream` and `tty.WriteStream`classes.
24
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/tty.js)
25
- */
26
- declare module "tty" {
27
- import * as net from "node:net";
28
- /**
29
- * The `tty.isatty()` method returns `true` if the given `fd` is associated with
30
- * a TTY and `false` if it is not, including whenever `fd` is not a non-negative
31
- * integer.
32
- * @since v0.5.8
33
- * @param fd A numeric file descriptor
34
- */
35
- function isatty(fd: number): boolean;
36
- /**
37
- * Represents the readable side of a TTY. In normal circumstances `process.stdin` will be the only `tty.ReadStream` instance in a Node.js
38
- * process and there should be no reason to create additional instances.
39
- * @since v0.5.8
40
- */
41
- class ReadStream extends net.Socket {
42
- constructor(fd: number, options?: net.SocketConstructorOpts);
43
- /**
44
- * A `boolean` that is `true` if the TTY is currently configured to operate as a
45
- * raw device.
46
- *
47
- * This flag is always `false` when a process starts, even if the terminal is
48
- * operating in raw mode. Its value will change with subsequent calls to`setRawMode`.
49
- * @since v0.7.7
50
- */
51
- isRaw: boolean;
52
- /**
53
- * Allows configuration of `tty.ReadStream` so that it operates as a raw device.
54
- *
55
- * When in raw mode, input is always available character-by-character, not
56
- * including modifiers. Additionally, all special processing of characters by the
57
- * terminal is disabled, including echoing input
58
- * characters. Ctrl+C will no longer cause a `SIGINT` when
59
- * in this mode.
60
- * @since v0.7.7
61
- * @param mode If `true`, configures the `tty.ReadStream` to operate as a raw device. If `false`, configures the `tty.ReadStream` to operate in its default mode. The `readStream.isRaw`
62
- * property will be set to the resulting mode.
63
- * @return The read stream instance.
64
- */
65
- setRawMode(mode: boolean): this;
66
- /**
67
- * A `boolean` that is always `true` for `tty.ReadStream` instances.
68
- * @since v0.5.8
69
- */
70
- isTTY: boolean;
71
- }
72
- /**
73
- * -1 - to the left from cursor
74
- * 0 - the entire line
75
- * 1 - to the right from cursor
76
- */
77
- type Direction = -1 | 0 | 1;
78
- /**
79
- * Represents the writable side of a TTY. In normal circumstances,`process.stdout` and `process.stderr` will be the only`tty.WriteStream` instances created for a Node.js process and there
80
- * should be no reason to create additional instances.
81
- * @since v0.5.8
82
- */
83
- class WriteStream extends net.Socket {
84
- constructor(fd: number);
85
- addListener(event: string, listener: (...args: any[]) => void): this;
86
- addListener(event: "resize", listener: () => void): this;
87
- emit(event: string | symbol, ...args: any[]): boolean;
88
- emit(event: "resize"): boolean;
89
- on(event: string, listener: (...args: any[]) => void): this;
90
- on(event: "resize", listener: () => void): this;
91
- once(event: string, listener: (...args: any[]) => void): this;
92
- once(event: "resize", listener: () => void): this;
93
- prependListener(event: string, listener: (...args: any[]) => void): this;
94
- prependListener(event: "resize", listener: () => void): this;
95
- prependOnceListener(event: string, listener: (...args: any[]) => void): this;
96
- prependOnceListener(event: "resize", listener: () => void): this;
97
- /**
98
- * `writeStream.clearLine()` clears the current line of this `WriteStream` in a
99
- * direction identified by `dir`.
100
- * @since v0.7.7
101
- * @param callback Invoked once the operation completes.
102
- * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
103
- */
104
- clearLine(dir: Direction, callback?: () => void): boolean;
105
- /**
106
- * `writeStream.clearScreenDown()` clears this `WriteStream` from the current
107
- * cursor down.
108
- * @since v0.7.7
109
- * @param callback Invoked once the operation completes.
110
- * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
111
- */
112
- clearScreenDown(callback?: () => void): boolean;
113
- /**
114
- * `writeStream.cursorTo()` moves this `WriteStream`'s cursor to the specified
115
- * position.
116
- * @since v0.7.7
117
- * @param callback Invoked once the operation completes.
118
- * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
119
- */
120
- cursorTo(x: number, y?: number, callback?: () => void): boolean;
121
- cursorTo(x: number, callback: () => void): boolean;
122
- /**
123
- * `writeStream.moveCursor()` moves this `WriteStream`'s cursor _relative_ to its
124
- * current position.
125
- * @since v0.7.7
126
- * @param callback Invoked once the operation completes.
127
- * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
128
- */
129
- moveCursor(dx: number, dy: number, callback?: () => void): boolean;
130
- /**
131
- * Returns:
132
- *
133
- * * `1` for 2,
134
- * * `4` for 16,
135
- * * `8` for 256,
136
- * * `24` for 16,777,216 colors supported.
137
- *
138
- * Use this to determine what colors the terminal supports. Due to the nature of
139
- * colors in terminals it is possible to either have false positives or false
140
- * negatives. It depends on process information and the environment variables that
141
- * may lie about what terminal is used.
142
- * It is possible to pass in an `env` object to simulate the usage of a specific
143
- * terminal. This can be useful to check how specific environment settings behave.
144
- *
145
- * To enforce a specific color support, use one of the below environment settings.
146
- *
147
- * * 2 colors: `FORCE_COLOR = 0` (Disables colors)
148
- * * 16 colors: `FORCE_COLOR = 1`
149
- * * 256 colors: `FORCE_COLOR = 2`
150
- * * 16,777,216 colors: `FORCE_COLOR = 3`
151
- *
152
- * Disabling color support is also possible by using the `NO_COLOR` and`NODE_DISABLE_COLORS` environment variables.
153
- * @since v9.9.0
154
- * @param [env=process.env] An object containing the environment variables to check. This enables simulating the usage of a specific terminal.
155
- */
156
- getColorDepth(env?: object): number;
157
- /**
158
- * Returns `true` if the `writeStream` supports at least as many colors as provided
159
- * in `count`. Minimum support is 2 (black and white).
160
- *
161
- * This has the same false positives and negatives as described in `writeStream.getColorDepth()`.
162
- *
163
- * ```js
164
- * process.stdout.hasColors();
165
- * // Returns true or false depending on if `stdout` supports at least 16 colors.
166
- * process.stdout.hasColors(256);
167
- * // Returns true or false depending on if `stdout` supports at least 256 colors.
168
- * process.stdout.hasColors({ TMUX: '1' });
169
- * // Returns true.
170
- * process.stdout.hasColors(2 ** 24, { TMUX: '1' });
171
- * // Returns false (the environment setting pretends to support 2 ** 8 colors).
172
- * ```
173
- * @since v11.13.0, v10.16.0
174
- * @param [count=16] The number of colors that are requested (minimum 2).
175
- * @param [env=process.env] An object containing the environment variables to check. This enables simulating the usage of a specific terminal.
176
- */
177
- hasColors(count?: number): boolean;
178
- hasColors(env?: object): boolean;
179
- hasColors(count: number, env?: object): boolean;
180
- /**
181
- * `writeStream.getWindowSize()` returns the size of the TTY
182
- * corresponding to this `WriteStream`. The array is of the type`[numColumns, numRows]` where `numColumns` and `numRows` represent the number
183
- * of columns and rows in the corresponding TTY.
184
- * @since v0.7.7
185
- */
186
- getWindowSize(): [number, number];
187
- /**
188
- * A `number` specifying the number of columns the TTY currently has. This property
189
- * is updated whenever the `'resize'` event is emitted.
190
- * @since v0.7.7
191
- */
192
- columns: number;
193
- /**
194
- * A `number` specifying the number of rows the TTY currently has. This property
195
- * is updated whenever the `'resize'` event is emitted.
196
- * @since v0.7.7
197
- */
198
- rows: number;
199
- /**
200
- * A `boolean` that is always `true`.
201
- * @since v0.5.8
202
- */
203
- isTTY: boolean;
204
- }
205
- }
206
- declare module "node:tty" {
207
- export * from "tty";
208
- }