@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,645 +0,0 @@
1
- /**
2
- * This module provides an implementation of a subset of the W3C [Web Performance APIs](https://w3c.github.io/perf-timing-primer/) as well as additional APIs for
3
- * Node.js-specific performance measurements.
4
- *
5
- * Node.js supports the following [Web Performance APIs](https://w3c.github.io/perf-timing-primer/):
6
- *
7
- * * [High Resolution Time](https://www.w3.org/TR/hr-time-2)
8
- * * [Performance Timeline](https://w3c.github.io/performance-timeline/)
9
- * * [User Timing](https://www.w3.org/TR/user-timing/)
10
- * * [Resource Timing](https://www.w3.org/TR/resource-timing-2/)
11
- *
12
- * ```js
13
- * const { PerformanceObserver, performance } = require('node:perf_hooks');
14
- *
15
- * const obs = new PerformanceObserver((items) => {
16
- * console.log(items.getEntries()[0].duration);
17
- * performance.clearMarks();
18
- * });
19
- * obs.observe({ type: 'measure' });
20
- * performance.measure('Start to Now');
21
- *
22
- * performance.mark('A');
23
- * doSomeLongRunningProcess(() => {
24
- * performance.measure('A to Now', 'A');
25
- *
26
- * performance.mark('B');
27
- * performance.measure('A to B', 'A', 'B');
28
- * });
29
- * ```
30
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/perf_hooks.js)
31
- */
32
- declare module "perf_hooks" {
33
- import { AsyncResource } from "node:async_hooks";
34
- type EntryType = "node" | "mark" | "measure" | "gc" | "function" | "http2" | "http" | "dns" | "net";
35
- interface NodeGCPerformanceDetail {
36
- /**
37
- * When `performanceEntry.entryType` is equal to 'gc', `the performance.kind` property identifies
38
- * the type of garbage collection operation that occurred.
39
- * See perf_hooks.constants for valid values.
40
- */
41
- readonly kind?: number | undefined;
42
- /**
43
- * When `performanceEntry.entryType` is equal to 'gc', the `performance.flags`
44
- * property contains additional information about garbage collection operation.
45
- * See perf_hooks.constants for valid values.
46
- */
47
- readonly flags?: number | undefined;
48
- }
49
- /**
50
- * The constructor of this class is not exposed to users directly.
51
- * @since v8.5.0
52
- */
53
- class PerformanceEntry {
54
- protected constructor();
55
- /**
56
- * The total number of milliseconds elapsed for this entry. This value will not
57
- * be meaningful for all Performance Entry types.
58
- * @since v8.5.0
59
- */
60
- readonly duration: number;
61
- /**
62
- * The name of the performance entry.
63
- * @since v8.5.0
64
- */
65
- readonly name: string;
66
- /**
67
- * The high resolution millisecond timestamp marking the starting time of the
68
- * Performance Entry.
69
- * @since v8.5.0
70
- */
71
- readonly startTime: number;
72
- /**
73
- * The type of the performance entry. It may be one of:
74
- *
75
- * * `'node'` (Node.js only)
76
- * * `'mark'` (available on the Web)
77
- * * `'measure'` (available on the Web)
78
- * * `'gc'` (Node.js only)
79
- * * `'function'` (Node.js only)
80
- * * `'http2'` (Node.js only)
81
- * * `'http'` (Node.js only)
82
- * @since v8.5.0
83
- */
84
- readonly entryType: EntryType;
85
- /**
86
- * Additional detail specific to the `entryType`.
87
- * @since v16.0.0
88
- */
89
- readonly detail?: NodeGCPerformanceDetail | unknown | undefined; // TODO: Narrow this based on entry type.
90
- toJSON(): any;
91
- }
92
- /**
93
- * Exposes marks created via the `Performance.mark()` method.
94
- * @since v18.2.0, v16.17.0
95
- */
96
- class PerformanceMark extends PerformanceEntry {
97
- readonly duration: 0;
98
- readonly entryType: "mark";
99
- }
100
- /**
101
- * Exposes measures created via the `Performance.measure()` method.
102
- *
103
- * The constructor of this class is not exposed to users directly.
104
- * @since v18.2.0, v16.17.0
105
- */
106
- class PerformanceMeasure extends PerformanceEntry {
107
- readonly entryType: "measure";
108
- }
109
- /**
110
- * _This property is an extension by Node.js. It is not available in Web browsers._
111
- *
112
- * Provides timing details for Node.js itself. The constructor of this class
113
- * is not exposed to users.
114
- * @since v8.5.0
115
- */
116
- class PerformanceNodeTiming extends PerformanceEntry {
117
- /**
118
- * The high resolution millisecond timestamp at which the Node.js process
119
- * completed bootstrapping. If bootstrapping has not yet finished, the property
120
- * has the value of -1.
121
- * @since v8.5.0
122
- */
123
- readonly bootstrapComplete: number;
124
- /**
125
- * The high resolution millisecond timestamp at which the Node.js environment was
126
- * initialized.
127
- * @since v8.5.0
128
- */
129
- readonly environment: number;
130
- /**
131
- * The high resolution millisecond timestamp of the amount of time the event loop
132
- * has been idle within the event loop's event provider (e.g. `epoll_wait`). This
133
- * does not take CPU usage into consideration. If the event loop has not yet
134
- * started (e.g., in the first tick of the main script), the property has the
135
- * value of 0.
136
- * @since v14.10.0, v12.19.0
137
- */
138
- readonly idleTime: number;
139
- /**
140
- * The high resolution millisecond timestamp at which the Node.js event loop
141
- * exited. If the event loop has not yet exited, the property has the value of -1\.
142
- * It can only have a value of not -1 in a handler of the `'exit'` event.
143
- * @since v8.5.0
144
- */
145
- readonly loopExit: number;
146
- /**
147
- * The high resolution millisecond timestamp at which the Node.js event loop
148
- * started. If the event loop has not yet started (e.g., in the first tick of the
149
- * main script), the property has the value of -1.
150
- * @since v8.5.0
151
- */
152
- readonly loopStart: number;
153
- /**
154
- * The high resolution millisecond timestamp at which the V8 platform was
155
- * initialized.
156
- * @since v8.5.0
157
- */
158
- readonly v8Start: number;
159
- }
160
- interface EventLoopUtilization {
161
- idle: number;
162
- active: number;
163
- utilization: number;
164
- }
165
- /**
166
- * @param util1 The result of a previous call to eventLoopUtilization()
167
- * @param util2 The result of a previous call to eventLoopUtilization() prior to util1
168
- */
169
- type EventLoopUtilityFunction = (
170
- util1?: EventLoopUtilization,
171
- util2?: EventLoopUtilization,
172
- ) => EventLoopUtilization;
173
- interface MarkOptions {
174
- /**
175
- * Additional optional detail to include with the mark.
176
- */
177
- detail?: unknown | undefined;
178
- /**
179
- * An optional timestamp to be used as the mark time.
180
- * @default `performance.now()`.
181
- */
182
- startTime?: number | undefined;
183
- }
184
- interface MeasureOptions {
185
- /**
186
- * Additional optional detail to include with the mark.
187
- */
188
- detail?: unknown | undefined;
189
- /**
190
- * Duration between start and end times.
191
- */
192
- duration?: number | undefined;
193
- /**
194
- * Timestamp to be used as the end time, or a string identifying a previously recorded mark.
195
- */
196
- end?: number | string | undefined;
197
- /**
198
- * Timestamp to be used as the start time, or a string identifying a previously recorded mark.
199
- */
200
- start?: number | string | undefined;
201
- }
202
- interface TimerifyOptions {
203
- /**
204
- * A histogram object created using
205
- * `perf_hooks.createHistogram()` that will record runtime durations in
206
- * nanoseconds.
207
- */
208
- histogram?: RecordableHistogram | undefined;
209
- }
210
- interface Performance {
211
- /**
212
- * If name is not provided, removes all PerformanceMark objects from the Performance Timeline.
213
- * If name is provided, removes only the named mark.
214
- * @param name
215
- */
216
- clearMarks(name?: string): void;
217
- /**
218
- * If name is not provided, removes all PerformanceMeasure objects from the Performance Timeline.
219
- * If name is provided, removes only the named measure.
220
- * @param name
221
- * @since v16.7.0
222
- */
223
- clearMeasures(name?: string): void;
224
- /**
225
- * Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`.
226
- * If you are only interested in performance entries of certain types or that have certain names, see
227
- * `performance.getEntriesByType()` and `performance.getEntriesByName()`.
228
- * @since v16.7.0
229
- */
230
- getEntries(): PerformanceEntry[];
231
- /**
232
- * Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`
233
- * whose `performanceEntry.name` is equal to `name`, and optionally, whose `performanceEntry.entryType` is equal to `type`.
234
- * @param name
235
- * @param type
236
- * @since v16.7.0
237
- */
238
- getEntriesByName(name: string, type?: EntryType): PerformanceEntry[];
239
- /**
240
- * Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`
241
- * whose `performanceEntry.entryType` is equal to `type`.
242
- * @param type
243
- * @since v16.7.0
244
- */
245
- getEntriesByType(type: EntryType): PerformanceEntry[];
246
- /**
247
- * Creates a new PerformanceMark entry in the Performance Timeline.
248
- * A PerformanceMark is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'mark',
249
- * and whose performanceEntry.duration is always 0.
250
- * Performance marks are used to mark specific significant moments in the Performance Timeline.
251
- * @param name
252
- * @return The PerformanceMark entry that was created
253
- */
254
- mark(name?: string, options?: MarkOptions): PerformanceMark;
255
- /**
256
- * Creates a new PerformanceMeasure entry in the Performance Timeline.
257
- * A PerformanceMeasure is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'measure',
258
- * and whose performanceEntry.duration measures the number of milliseconds elapsed since startMark and endMark.
259
- *
260
- * The startMark argument may identify any existing PerformanceMark in the the Performance Timeline, or may identify
261
- * any of the timestamp properties provided by the PerformanceNodeTiming class. If the named startMark does not exist,
262
- * then startMark is set to timeOrigin by default.
263
- *
264
- * The endMark argument must identify any existing PerformanceMark in the the Performance Timeline or any of the timestamp
265
- * properties provided by the PerformanceNodeTiming class. If the named endMark does not exist, an error will be thrown.
266
- * @param name
267
- * @param startMark
268
- * @param endMark
269
- * @return The PerformanceMeasure entry that was created
270
- */
271
- measure(name: string, startMark?: string, endMark?: string): PerformanceMeasure;
272
- measure(name: string, options: MeasureOptions): PerformanceMeasure;
273
- /**
274
- * An instance of the PerformanceNodeTiming class that provides performance metrics for specific Node.js operational milestones.
275
- */
276
- readonly nodeTiming: PerformanceNodeTiming;
277
- /**
278
- * @return the current high resolution millisecond timestamp
279
- */
280
- now(): number;
281
- /**
282
- * The timeOrigin specifies the high resolution millisecond timestamp from which all performance metric durations are measured.
283
- */
284
- readonly timeOrigin: number;
285
- /**
286
- * Wraps a function within a new function that measures the running time of the wrapped function.
287
- * A PerformanceObserver must be subscribed to the 'function' event type in order for the timing details to be accessed.
288
- * @param fn
289
- */
290
- timerify<T extends (...params: any[]) => any>(fn: T, options?: TimerifyOptions): T;
291
- /**
292
- * eventLoopUtilization is similar to CPU utilization except that it is calculated using high precision wall-clock time.
293
- * It represents the percentage of time the event loop has spent outside the event loop's event provider (e.g. epoll_wait).
294
- * No other CPU idle time is taken into consideration.
295
- */
296
- eventLoopUtilization: EventLoopUtilityFunction;
297
- }
298
- interface PerformanceObserverEntryList {
299
- /**
300
- * Returns a list of `PerformanceEntry` objects in chronological order
301
- * with respect to `performanceEntry.startTime`.
302
- *
303
- * ```js
304
- * const {
305
- * performance,
306
- * PerformanceObserver,
307
- * } = require('node:perf_hooks');
308
- *
309
- * const obs = new PerformanceObserver((perfObserverList, observer) => {
310
- * console.log(perfObserverList.getEntries());
311
- *
312
- * * [
313
- * * PerformanceEntry {
314
- * * name: 'test',
315
- * * entryType: 'mark',
316
- * * startTime: 81.465639,
317
- * * duration: 0,
318
- * * detail: null
319
- * * },
320
- * * PerformanceEntry {
321
- * * name: 'meow',
322
- * * entryType: 'mark',
323
- * * startTime: 81.860064,
324
- * * duration: 0,
325
- * * detail: null
326
- * * }
327
- * * ]
328
- *
329
- * performance.clearMarks();
330
- * performance.clearMeasures();
331
- * observer.disconnect();
332
- * });
333
- * obs.observe({ type: 'mark' });
334
- *
335
- * performance.mark('test');
336
- * performance.mark('meow');
337
- * ```
338
- * @since v8.5.0
339
- */
340
- getEntries(): PerformanceEntry[];
341
- /**
342
- * Returns a list of `PerformanceEntry` objects in chronological order
343
- * with respect to `performanceEntry.startTime` whose `performanceEntry.name` is
344
- * equal to `name`, and optionally, whose `performanceEntry.entryType` is equal to`type`.
345
- *
346
- * ```js
347
- * const {
348
- * performance,
349
- * PerformanceObserver,
350
- * } = require('node:perf_hooks');
351
- *
352
- * const obs = new PerformanceObserver((perfObserverList, observer) => {
353
- * console.log(perfObserverList.getEntriesByName('meow'));
354
- *
355
- * * [
356
- * * PerformanceEntry {
357
- * * name: 'meow',
358
- * * entryType: 'mark',
359
- * * startTime: 98.545991,
360
- * * duration: 0,
361
- * * detail: null
362
- * * }
363
- * * ]
364
- *
365
- * console.log(perfObserverList.getEntriesByName('nope')); // []
366
- *
367
- * console.log(perfObserverList.getEntriesByName('test', 'mark'));
368
- *
369
- * * [
370
- * * PerformanceEntry {
371
- * * name: 'test',
372
- * * entryType: 'mark',
373
- * * startTime: 63.518931,
374
- * * duration: 0,
375
- * * detail: null
376
- * * }
377
- * * ]
378
- *
379
- * console.log(perfObserverList.getEntriesByName('test', 'measure')); // []
380
- *
381
- * performance.clearMarks();
382
- * performance.clearMeasures();
383
- * observer.disconnect();
384
- * });
385
- * obs.observe({ entryTypes: ['mark', 'measure'] });
386
- *
387
- * performance.mark('test');
388
- * performance.mark('meow');
389
- * ```
390
- * @since v8.5.0
391
- */
392
- getEntriesByName(name: string, type?: EntryType): PerformanceEntry[];
393
- /**
394
- * Returns a list of `PerformanceEntry` objects in chronological order
395
- * with respect to `performanceEntry.startTime` whose `performanceEntry.entryType`is equal to `type`.
396
- *
397
- * ```js
398
- * const {
399
- * performance,
400
- * PerformanceObserver,
401
- * } = require('node:perf_hooks');
402
- *
403
- * const obs = new PerformanceObserver((perfObserverList, observer) => {
404
- * console.log(perfObserverList.getEntriesByType('mark'));
405
- *
406
- * * [
407
- * * PerformanceEntry {
408
- * * name: 'test',
409
- * * entryType: 'mark',
410
- * * startTime: 55.897834,
411
- * * duration: 0,
412
- * * detail: null
413
- * * },
414
- * * PerformanceEntry {
415
- * * name: 'meow',
416
- * * entryType: 'mark',
417
- * * startTime: 56.350146,
418
- * * duration: 0,
419
- * * detail: null
420
- * * }
421
- * * ]
422
- *
423
- * performance.clearMarks();
424
- * performance.clearMeasures();
425
- * observer.disconnect();
426
- * });
427
- * obs.observe({ type: 'mark' });
428
- *
429
- * performance.mark('test');
430
- * performance.mark('meow');
431
- * ```
432
- * @since v8.5.0
433
- */
434
- getEntriesByType(type: EntryType): PerformanceEntry[];
435
- }
436
- type PerformanceObserverCallback = (list: PerformanceObserverEntryList, observer: PerformanceObserver) => void;
437
- /**
438
- * @since v8.5.0
439
- */
440
- class PerformanceObserver extends AsyncResource {
441
- constructor(callback: PerformanceObserverCallback);
442
- /**
443
- * Disconnects the `PerformanceObserver` instance from all notifications.
444
- * @since v8.5.0
445
- */
446
- disconnect(): void;
447
- /**
448
- * Subscribes the `PerformanceObserver` instance to notifications of new `PerformanceEntry` instances identified either by `options.entryTypes`or `options.type`:
449
- *
450
- * ```js
451
- * const {
452
- * performance,
453
- * PerformanceObserver,
454
- * } = require('node:perf_hooks');
455
- *
456
- * const obs = new PerformanceObserver((list, observer) => {
457
- * // Called once asynchronously. `list` contains three items.
458
- * });
459
- * obs.observe({ type: 'mark' });
460
- *
461
- * for (let n = 0; n < 3; n++)
462
- * performance.mark(`test${n}`);
463
- * ```
464
- * @since v8.5.0
465
- */
466
- observe(
467
- options:
468
- | {
469
- entryTypes: readonly EntryType[];
470
- buffered?: boolean | undefined;
471
- }
472
- | {
473
- type: EntryType;
474
- buffered?: boolean | undefined;
475
- },
476
- ): void;
477
- }
478
- namespace constants {
479
- const NODE_PERFORMANCE_GC_MAJOR: number;
480
- const NODE_PERFORMANCE_GC_MINOR: number;
481
- const NODE_PERFORMANCE_GC_INCREMENTAL: number;
482
- const NODE_PERFORMANCE_GC_WEAKCB: number;
483
- const NODE_PERFORMANCE_GC_FLAGS_NO: number;
484
- const NODE_PERFORMANCE_GC_FLAGS_CONSTRUCT_RETAINED: number;
485
- const NODE_PERFORMANCE_GC_FLAGS_FORCED: number;
486
- const NODE_PERFORMANCE_GC_FLAGS_SYNCHRONOUS_PHANTOM_PROCESSING: number;
487
- const NODE_PERFORMANCE_GC_FLAGS_ALL_AVAILABLE_GARBAGE: number;
488
- const NODE_PERFORMANCE_GC_FLAGS_ALL_EXTERNAL_MEMORY: number;
489
- const NODE_PERFORMANCE_GC_FLAGS_SCHEDULE_IDLE: number;
490
- }
491
- const performance: Performance;
492
- interface EventLoopMonitorOptions {
493
- /**
494
- * The sampling rate in milliseconds.
495
- * Must be greater than zero.
496
- * @default 10
497
- */
498
- resolution?: number | undefined;
499
- }
500
- interface Histogram {
501
- /**
502
- * Returns a `Map` object detailing the accumulated percentile distribution.
503
- * @since v11.10.0
504
- */
505
- readonly percentiles: Map<number, number>;
506
- /**
507
- * The number of times the event loop delay exceeded the maximum 1 hour event
508
- * loop delay threshold.
509
- * @since v11.10.0
510
- */
511
- readonly exceeds: number;
512
- /**
513
- * The minimum recorded event loop delay.
514
- * @since v11.10.0
515
- */
516
- readonly min: number;
517
- /**
518
- * The maximum recorded event loop delay.
519
- * @since v11.10.0
520
- */
521
- readonly max: number;
522
- /**
523
- * The mean of the recorded event loop delays.
524
- * @since v11.10.0
525
- */
526
- readonly mean: number;
527
- /**
528
- * The standard deviation of the recorded event loop delays.
529
- * @since v11.10.0
530
- */
531
- readonly stddev: number;
532
- /**
533
- * Resets the collected histogram data.
534
- * @since v11.10.0
535
- */
536
- reset(): void;
537
- /**
538
- * Returns the value at the given percentile.
539
- * @since v11.10.0
540
- * @param percentile A percentile value in the range (0, 100].
541
- */
542
- percentile(percentile: number): number;
543
- }
544
- interface IntervalHistogram extends Histogram {
545
- /**
546
- * Enables the update interval timer. Returns `true` if the timer was
547
- * started, `false` if it was already started.
548
- * @since v11.10.0
549
- */
550
- enable(): boolean;
551
- /**
552
- * Disables the update interval timer. Returns `true` if the timer was
553
- * stopped, `false` if it was already stopped.
554
- * @since v11.10.0
555
- */
556
- disable(): boolean;
557
- }
558
- interface RecordableHistogram extends Histogram {
559
- /**
560
- * @since v15.9.0, v14.18.0
561
- * @param val The amount to record in the histogram.
562
- */
563
- record(val: number | bigint): void;
564
- /**
565
- * Calculates the amount of time (in nanoseconds) that has passed since the
566
- * previous call to `recordDelta()` and records that amount in the histogram.
567
- *
568
- * ## Examples
569
- * @since v15.9.0, v14.18.0
570
- */
571
- recordDelta(): void;
572
- /**
573
- * Adds the values from `other` to this histogram.
574
- * @since v17.4.0, v16.14.0
575
- */
576
- add(other: RecordableHistogram): void;
577
- }
578
- /**
579
- * _This property is an extension by Node.js. It is not available in Web browsers._
580
- *
581
- * Creates an `IntervalHistogram` object that samples and reports the event loop
582
- * delay over time. The delays will be reported in nanoseconds.
583
- *
584
- * Using a timer to detect approximate event loop delay works because the
585
- * execution of timers is tied specifically to the lifecycle of the libuv
586
- * event loop. That is, a delay in the loop will cause a delay in the execution
587
- * of the timer, and those delays are specifically what this API is intended to
588
- * detect.
589
- *
590
- * ```js
591
- * const { monitorEventLoopDelay } = require('node:perf_hooks');
592
- * const h = monitorEventLoopDelay({ resolution: 20 });
593
- * h.enable();
594
- * // Do something.
595
- * h.disable();
596
- * console.log(h.min);
597
- * console.log(h.max);
598
- * console.log(h.mean);
599
- * console.log(h.stddev);
600
- * console.log(h.percentiles);
601
- * console.log(h.percentile(50));
602
- * console.log(h.percentile(99));
603
- * ```
604
- * @since v11.10.0
605
- */
606
- function monitorEventLoopDelay(options?: EventLoopMonitorOptions): IntervalHistogram;
607
- interface CreateHistogramOptions {
608
- /**
609
- * The minimum recordable value. Must be an integer value greater than 0.
610
- * @default 1
611
- */
612
- min?: number | bigint | undefined;
613
- /**
614
- * The maximum recordable value. Must be an integer value greater than min.
615
- * @default Number.MAX_SAFE_INTEGER
616
- */
617
- max?: number | bigint | undefined;
618
- /**
619
- * The number of accuracy digits. Must be a number between 1 and 5.
620
- * @default 3
621
- */
622
- figures?: number | undefined;
623
- }
624
- /**
625
- * Returns a `RecordableHistogram`.
626
- * @since v15.9.0, v14.18.0
627
- */
628
- function createHistogram(options?: CreateHistogramOptions): RecordableHistogram;
629
- import { performance as _performance } from "perf_hooks";
630
- global {
631
- /**
632
- * `performance` is a global reference for `require('perf_hooks').performance`
633
- * https://nodejs.org/api/globals.html#performance
634
- * @since v16.0.0
635
- */
636
- var performance: typeof globalThis extends {
637
- onmessage: any;
638
- performance: infer T;
639
- } ? T
640
- : typeof _performance;
641
- }
642
- }
643
- declare module "node:perf_hooks" {
644
- export * from "perf_hooks";
645
- }