cdk-ecr-deployment 3.0.6 → 3.0.8

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 (75) hide show
  1. package/.jsii +2 -2
  2. package/lib/index.js +3 -3
  3. package/node_modules/@types/cacheable-request/node_modules/@types/node/README.md +1 -1
  4. package/node_modules/@types/cacheable-request/node_modules/@types/node/buffer.d.ts +1 -1
  5. package/node_modules/@types/cacheable-request/node_modules/@types/node/crypto.d.ts +4 -3
  6. package/node_modules/@types/cacheable-request/node_modules/@types/node/dgram.d.ts +4 -4
  7. package/node_modules/@types/cacheable-request/node_modules/@types/node/diagnostics_channel.d.ts +355 -1
  8. package/node_modules/@types/cacheable-request/node_modules/@types/node/http.d.ts +6 -7
  9. package/node_modules/@types/cacheable-request/node_modules/@types/node/module.d.ts +14 -0
  10. package/node_modules/@types/cacheable-request/node_modules/@types/node/package.json +2 -2
  11. package/node_modules/@types/cacheable-request/node_modules/@types/node/perf_hooks.d.ts +12 -6
  12. package/node_modules/@types/cacheable-request/node_modules/@types/node/process.d.ts +8 -3
  13. package/node_modules/@types/cacheable-request/node_modules/@types/node/querystring.d.ts +3 -3
  14. package/node_modules/@types/cacheable-request/node_modules/@types/node/test.d.ts +62 -10
  15. package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/buffer.d.ts +1 -1
  16. package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/crypto.d.ts +4 -3
  17. package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/dgram.d.ts +4 -4
  18. package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +355 -1
  19. package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/http.d.ts +6 -7
  20. package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/module.d.ts +14 -0
  21. package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/perf_hooks.d.ts +13 -7
  22. package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/process.d.ts +8 -3
  23. package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/querystring.d.ts +3 -3
  24. package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/test.d.ts +62 -10
  25. package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/wasi.d.ts +9 -5
  26. package/node_modules/@types/cacheable-request/node_modules/@types/node/wasi.d.ts +9 -5
  27. package/node_modules/@types/keyv/node_modules/@types/node/README.md +1 -1
  28. package/node_modules/@types/keyv/node_modules/@types/node/buffer.d.ts +1 -1
  29. package/node_modules/@types/keyv/node_modules/@types/node/crypto.d.ts +4 -3
  30. package/node_modules/@types/keyv/node_modules/@types/node/dgram.d.ts +4 -4
  31. package/node_modules/@types/keyv/node_modules/@types/node/diagnostics_channel.d.ts +355 -1
  32. package/node_modules/@types/keyv/node_modules/@types/node/http.d.ts +6 -7
  33. package/node_modules/@types/keyv/node_modules/@types/node/module.d.ts +14 -0
  34. package/node_modules/@types/keyv/node_modules/@types/node/package.json +2 -2
  35. package/node_modules/@types/keyv/node_modules/@types/node/perf_hooks.d.ts +12 -6
  36. package/node_modules/@types/keyv/node_modules/@types/node/process.d.ts +8 -3
  37. package/node_modules/@types/keyv/node_modules/@types/node/querystring.d.ts +3 -3
  38. package/node_modules/@types/keyv/node_modules/@types/node/test.d.ts +62 -10
  39. package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/buffer.d.ts +1 -1
  40. package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/crypto.d.ts +4 -3
  41. package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/dgram.d.ts +4 -4
  42. package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +355 -1
  43. package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/http.d.ts +6 -7
  44. package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/module.d.ts +14 -0
  45. package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/perf_hooks.d.ts +13 -7
  46. package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/process.d.ts +8 -3
  47. package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/querystring.d.ts +3 -3
  48. package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/test.d.ts +62 -10
  49. package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/wasi.d.ts +9 -5
  50. package/node_modules/@types/keyv/node_modules/@types/node/wasi.d.ts +9 -5
  51. package/node_modules/@types/responselike/node_modules/@types/node/README.md +1 -1
  52. package/node_modules/@types/responselike/node_modules/@types/node/buffer.d.ts +1 -1
  53. package/node_modules/@types/responselike/node_modules/@types/node/crypto.d.ts +4 -3
  54. package/node_modules/@types/responselike/node_modules/@types/node/dgram.d.ts +4 -4
  55. package/node_modules/@types/responselike/node_modules/@types/node/diagnostics_channel.d.ts +355 -1
  56. package/node_modules/@types/responselike/node_modules/@types/node/http.d.ts +6 -7
  57. package/node_modules/@types/responselike/node_modules/@types/node/module.d.ts +14 -0
  58. package/node_modules/@types/responselike/node_modules/@types/node/package.json +2 -2
  59. package/node_modules/@types/responselike/node_modules/@types/node/perf_hooks.d.ts +12 -6
  60. package/node_modules/@types/responselike/node_modules/@types/node/process.d.ts +8 -3
  61. package/node_modules/@types/responselike/node_modules/@types/node/querystring.d.ts +3 -3
  62. package/node_modules/@types/responselike/node_modules/@types/node/test.d.ts +62 -10
  63. package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/buffer.d.ts +1 -1
  64. package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/crypto.d.ts +4 -3
  65. package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/dgram.d.ts +4 -4
  66. package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +355 -1
  67. package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/http.d.ts +6 -7
  68. package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/module.d.ts +14 -0
  69. package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/perf_hooks.d.ts +13 -7
  70. package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/process.d.ts +8 -3
  71. package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/querystring.d.ts +3 -3
  72. package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/test.d.ts +62 -10
  73. package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/wasi.d.ts +9 -5
  74. package/node_modules/@types/responselike/node_modules/@types/node/wasi.d.ts +9 -5
  75. package/package.json +1 -1
@@ -82,6 +82,11 @@ declare module "node:test" {
82
82
  import { Readable } from "node:stream";
83
83
  import { AsyncResource } from "node:async_hooks";
84
84
  /**
85
+ * **Note:**`shard` is used to horizontally parallelize test running across
86
+ * machines or processes, ideal for large-scale executions across varied
87
+ * environments. It's incompatible with `watch` mode, tailored for rapid
88
+ * code iteration by automatically rerunning tests on file changes.
89
+ *
85
90
  * ```js
86
91
  * import { tap } from 'node:test/reporters';
87
92
  * import { run } from 'node:test';
@@ -1013,6 +1018,8 @@ declare module "node:test" {
1013
1018
  * control the behavior of timers, such as `setInterval` and `setTimeout`,
1014
1019
  * without actually waiting for the specified time intervals.
1015
1020
  *
1021
+ * MockTimers is also able to mock the `Date` object.
1022
+ *
1016
1023
  * The `MockTracker` provides a top-level `timers` export
1017
1024
  * which is a `MockTimers` instance.
1018
1025
  * @since v20.4.0
@@ -1025,21 +1032,38 @@ declare module "node:test" {
1025
1032
  * **Note:** When you enable mocking for a specific timer, its associated
1026
1033
  * clear function will also be implicitly mocked.
1027
1034
  *
1028
- * Example usage:
1035
+ * **Note:** Mocking `Date` will affect the behavior of the mocked timers
1036
+ * as they use the same internal clock.
1037
+ *
1038
+ * Example usage without setting initial time:
1029
1039
  *
1030
1040
  * ```js
1031
1041
  * import { mock } from 'node:test';
1032
- * mock.timers.enable(['setInterval']);
1042
+ * mock.timers.enable({ apis: ['setInterval'] });
1033
1043
  * ```
1034
1044
  *
1035
1045
  * The above example enables mocking for the `setInterval` timer and
1036
1046
  * implicitly mocks the `clearInterval` function. Only the `setInterval`and `clearInterval` functions from `node:timers`,`node:timers/promises`, and`globalThis` will be mocked.
1037
1047
  *
1048
+ * Example usage with initial time set
1049
+ *
1050
+ * ```js
1051
+ * import { mock } from 'node:test';
1052
+ * mock.timers.enable({ apis: ['Date'], now: 1000 });
1053
+ * ```
1054
+ *
1055
+ * Example usage with initial Date object as time set
1056
+ *
1057
+ * ```js
1058
+ * import { mock } from 'node:test';
1059
+ * mock.timers.enable({ apis: ['Date'], now: new Date() });
1060
+ * ```
1061
+ *
1038
1062
  * Alternatively, if you call `mock.timers.enable()` without any parameters:
1039
1063
  *
1040
1064
  * All timers (`'setInterval'`, `'clearInterval'`, `'setTimeout'`, and `'clearTimeout'`)
1041
1065
  * will be mocked. The `setInterval`, `clearInterval`, `setTimeout`, and `clearTimeout`functions from `node:timers`, `node:timers/promises`,
1042
- * and `globalThis` will be mocked.
1066
+ * and `globalThis` will be mocked. As well as the global `Date` object.
1043
1067
  * @since v20.4.0
1044
1068
  */
1045
1069
  enable(timers?: Timer[]): void;
@@ -1076,7 +1100,7 @@ declare module "node:test" {
1076
1100
  * test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
1077
1101
  * const fn = context.mock.fn();
1078
1102
  *
1079
- * context.mock.timers.enable(['setTimeout']);
1103
+ * context.mock.timers.enable({ apis: ['setTimeout'] });
1080
1104
  *
1081
1105
  * setTimeout(fn, 9999);
1082
1106
  *
@@ -1097,7 +1121,7 @@ declare module "node:test" {
1097
1121
  *
1098
1122
  * test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
1099
1123
  * const fn = context.mock.fn();
1100
- * context.mock.timers.enable(['setTimeout']);
1124
+ * context.mock.timers.enable({ apis: ['setTimeout'] });
1101
1125
  * const nineSecs = 9000;
1102
1126
  * setTimeout(fn, nineSecs);
1103
1127
  *
@@ -1109,11 +1133,35 @@ declare module "node:test" {
1109
1133
  * assert.strictEqual(fn.mock.callCount(), 1);
1110
1134
  * });
1111
1135
  * ```
1136
+ *
1137
+ * Advancing time using `.tick` will also advance the time for any `Date` object
1138
+ * created after the mock was enabled (if `Date` was also set to be mocked).
1139
+ *
1140
+ * ```js
1141
+ * import assert from 'node:assert';
1142
+ * import { test } from 'node:test';
1143
+ *
1144
+ * test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
1145
+ * const fn = context.mock.fn();
1146
+ *
1147
+ * context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
1148
+ * setTimeout(fn, 9999);
1149
+ *
1150
+ * assert.strictEqual(fn.mock.callCount(), 0);
1151
+ * assert.strictEqual(Date.now(), 0);
1152
+ *
1153
+ * // Advance in time
1154
+ * context.mock.timers.tick(9999);
1155
+ * assert.strictEqual(fn.mock.callCount(), 1);
1156
+ * assert.strictEqual(Date.now(), 9999);
1157
+ * });
1158
+ * ```
1112
1159
  * @since v20.4.0
1113
1160
  */
1114
1161
  tick(milliseconds: number): void;
1115
1162
  /**
1116
- * Triggers all pending mocked timers immediately.
1163
+ * Triggers all pending mocked timers immediately. If the `Date` object is also
1164
+ * mocked, it will also advance the `Date` object to the furthest timer's time.
1117
1165
  *
1118
1166
  * The example below triggers all pending timers immediately,
1119
1167
  * causing them to execute without any delay.
@@ -1123,7 +1171,7 @@ declare module "node:test" {
1123
1171
  * import { test } from 'node:test';
1124
1172
  *
1125
1173
  * test('runAll functions following the given order', (context) => {
1126
- * context.mock.timers.enable(['setTimeout']);
1174
+ * context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
1127
1175
  * const results = [];
1128
1176
  * setTimeout(() => results.push(1), 9999);
1129
1177
  *
@@ -1135,8 +1183,9 @@ declare module "node:test" {
1135
1183
  * assert.deepStrictEqual(results, []);
1136
1184
  *
1137
1185
  * context.mock.timers.runAll();
1138
- *
1139
1186
  * assert.deepStrictEqual(results, [3, 2, 1]);
1187
+ * // The Date object is also advanced to the furthest timer's time
1188
+ * assert.strictEqual(Date.now(), 9999);
1140
1189
  * });
1141
1190
  * ```
1142
1191
  *
@@ -1343,7 +1392,7 @@ interface TestDequeue extends TestLocationInfo {
1343
1392
  * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/test/reporters.js)
1344
1393
  */
1345
1394
  declare module "node:test/reporters" {
1346
- import { Transform } from "node:stream";
1395
+ import { Transform, TransformOptions } from "node:stream";
1347
1396
 
1348
1397
  type TestEvent =
1349
1398
  | { type: "test:diagnostic"; data: DiagnosticData }
@@ -1378,5 +1427,8 @@ declare module "node:test/reporters" {
1378
1427
  * The `junit` reporter outputs test results in a jUnit XML format
1379
1428
  */
1380
1429
  function junit(source: TestEventGenerator): AsyncGenerator<string, void>;
1381
- export { dot, junit, Spec as spec, tap, TestEvent };
1430
+ class Lcov extends Transform {
1431
+ constructor(opts?: TransformOptions);
1432
+ }
1433
+ export { dot, junit, Lcov as lcov, Spec as spec, tap, TestEvent };
1382
1434
  }
@@ -564,7 +564,7 @@ declare module "buffer" {
564
564
  *
565
565
  * The `Buffer` module pre-allocates an internal `Buffer` instance of
566
566
  * size `Buffer.poolSize` that is used as a pool for the fast allocation of new`Buffer` instances created using `Buffer.allocUnsafe()`, `Buffer.from(array)`,
567
- * and `Buffer.concat()` only when `size` is less than or equal to`Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two).
567
+ * and `Buffer.concat()` only when `size` is less than`Buffer.poolSize >>> 1` (floor of `Buffer.poolSize` divided by two).
568
568
  *
569
569
  * Use of this pre-allocated internal memory pool is a key difference between
570
570
  * calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.
@@ -638,9 +638,10 @@ declare module "crypto" {
638
638
  export(options?: KeyExportOptions<"der">): Buffer;
639
639
  export(options?: JwkKeyExportOptions): JsonWebKey;
640
640
  /**
641
- * Returns `true` or `false` depending on whether the keys have exactly the same type, value, and parameters.
642
- * This method is not [constant time](https://en.wikipedia.org/wiki/Timing_attack).
643
- * @since v16.15.0
641
+ * Returns `true` or `false` depending on whether the keys have exactly the same
642
+ * type, value, and parameters. This method is not [constant time](https://en.wikipedia.org/wiki/Timing_attack).
643
+ * @since v17.7.0, v16.15.0
644
+ * @param otherKeyObject A `KeyObject` with which to compare `keyObject`.
644
645
  */
645
646
  equals(otherKeyObject: KeyObject): boolean;
646
647
  /**
@@ -228,13 +228,13 @@ declare module "dgram" {
228
228
  */
229
229
  getSendBufferSize(): number;
230
230
  /**
231
- * @since v18.8.0,v16.19.0
232
- * @return the number of bytes queued for sending.
231
+ * @since v18.8.0, v16.19.0
232
+ * @return Number of bytes queued for sending.
233
233
  */
234
234
  getSendQueueSize(): number;
235
235
  /**
236
- * @since v18.8.0,v16.19.0
237
- * @return the number of send requests currently in the queue awaiting to be processed.
236
+ * @since v18.8.0, v16.19.0
237
+ * @return Number of send requests currently in the queue awaiting to be processed.
238
238
  */
239
239
  getSendQueueCount(): number;
240
240
  /**
@@ -23,6 +23,7 @@
23
23
  * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/diagnostics_channel.js)
24
24
  */
25
25
  declare module "diagnostics_channel" {
26
+ import { AsyncLocalStorage } from "node:async_hooks";
26
27
  /**
27
28
  * Check if there are active subscribers to the named channel. This is helpful if
28
29
  * the message you want to send might be expensive to prepare.
@@ -95,6 +96,36 @@ declare module "diagnostics_channel" {
95
96
  * @return `true` if the handler was found, `false` otherwise.
96
97
  */
97
98
  function unsubscribe(name: string | symbol, onMessage: ChannelListener): boolean;
99
+ /**
100
+ * Creates a `TracingChannel` wrapper for the given `TracingChannel Channels`. If a name is given, the corresponding tracing
101
+ * channels will be created in the form of `tracing:${name}:${eventType}` where`eventType` corresponds to the types of `TracingChannel Channels`.
102
+ *
103
+ * ```js
104
+ * import diagnostics_channel from 'node:diagnostics_channel';
105
+ *
106
+ * const channelsByName = diagnostics_channel.tracingChannel('my-channel');
107
+ *
108
+ * // or...
109
+ *
110
+ * const channelsByCollection = diagnostics_channel.tracingChannel({
111
+ * start: diagnostics_channel.channel('tracing:my-channel:start'),
112
+ * end: diagnostics_channel.channel('tracing:my-channel:end'),
113
+ * asyncStart: diagnostics_channel.channel('tracing:my-channel:asyncStart'),
114
+ * asyncEnd: diagnostics_channel.channel('tracing:my-channel:asyncEnd'),
115
+ * error: diagnostics_channel.channel('tracing:my-channel:error'),
116
+ * });
117
+ * ```
118
+ * @since v19.9.0
119
+ * @experimental
120
+ * @param nameOrChannels Channel name or object containing all the `TracingChannel Channels`
121
+ * @return Collection of channels to trace with
122
+ */
123
+ function tracingChannel<
124
+ StoreType = unknown,
125
+ ContextType extends object = StoreType extends object ? StoreType : object,
126
+ >(
127
+ nameOrChannels: string | TracingChannelCollection<StoreType, ContextType>,
128
+ ): TracingChannel<StoreType, ContextType>;
98
129
  /**
99
130
  * The class `Channel` represents an individual named channel within the data
100
131
  * pipeline. It is used to track subscribers and to publish messages when there
@@ -104,7 +135,7 @@ declare module "diagnostics_channel" {
104
135
  * with `new Channel(name)` is not supported.
105
136
  * @since v15.1.0, v14.17.0
106
137
  */
107
- class Channel {
138
+ class Channel<StoreType = unknown, ContextType = StoreType> {
108
139
  readonly name: string | symbol;
109
140
  /**
110
141
  * Check if there are active subscribers to this channel. This is helpful if
@@ -184,6 +215,329 @@ declare module "diagnostics_channel" {
184
215
  * @return `true` if the handler was found, `false` otherwise.
185
216
  */
186
217
  unsubscribe(onMessage: ChannelListener): void;
218
+ /**
219
+ * When `channel.runStores(context, ...)` is called, the given context data
220
+ * will be applied to any store bound to the channel. If the store has already been
221
+ * bound the previous `transform` function will be replaced with the new one.
222
+ * The `transform` function may be omitted to set the given context data as the
223
+ * context directly.
224
+ *
225
+ * ```js
226
+ * import diagnostics_channel from 'node:diagnostics_channel';
227
+ * import { AsyncLocalStorage } from 'node:async_hooks';
228
+ *
229
+ * const store = new AsyncLocalStorage();
230
+ *
231
+ * const channel = diagnostics_channel.channel('my-channel');
232
+ *
233
+ * channel.bindStore(store, (data) => {
234
+ * return { data };
235
+ * });
236
+ * ```
237
+ * @since v19.9.0
238
+ * @experimental
239
+ * @param store The store to which to bind the context data
240
+ * @param transform Transform context data before setting the store context
241
+ */
242
+ bindStore(store: AsyncLocalStorage<StoreType>, transform?: (context: ContextType) => StoreType): void;
243
+ /**
244
+ * Remove a message handler previously registered to this channel with `channel.bindStore(store)`.
245
+ *
246
+ * ```js
247
+ * import diagnostics_channel from 'node:diagnostics_channel';
248
+ * import { AsyncLocalStorage } from 'node:async_hooks';
249
+ *
250
+ * const store = new AsyncLocalStorage();
251
+ *
252
+ * const channel = diagnostics_channel.channel('my-channel');
253
+ *
254
+ * channel.bindStore(store);
255
+ * channel.unbindStore(store);
256
+ * ```
257
+ * @since v19.9.0
258
+ * @experimental
259
+ * @param store The store to unbind from the channel.
260
+ * @return `true` if the store was found, `false` otherwise.
261
+ */
262
+ unbindStore(store: any): void;
263
+ /**
264
+ * Applies the given data to any AsyncLocalStorage instances bound to the channel
265
+ * for the duration of the given function, then publishes to the channel within
266
+ * the scope of that data is applied to the stores.
267
+ *
268
+ * If a transform function was given to `channel.bindStore(store)` it will be
269
+ * applied to transform the message data before it becomes the context value for
270
+ * the store. The prior storage context is accessible from within the transform
271
+ * function in cases where context linking is required.
272
+ *
273
+ * The context applied to the store should be accessible in any async code which
274
+ * continues from execution which began during the given function, however
275
+ * there are some situations in which `context loss` may occur.
276
+ *
277
+ * ```js
278
+ * import diagnostics_channel from 'node:diagnostics_channel';
279
+ * import { AsyncLocalStorage } from 'node:async_hooks';
280
+ *
281
+ * const store = new AsyncLocalStorage();
282
+ *
283
+ * const channel = diagnostics_channel.channel('my-channel');
284
+ *
285
+ * channel.bindStore(store, (message) => {
286
+ * const parent = store.getStore();
287
+ * return new Span(message, parent);
288
+ * });
289
+ * channel.runStores({ some: 'message' }, () => {
290
+ * store.getStore(); // Span({ some: 'message' })
291
+ * });
292
+ * ```
293
+ * @since v19.9.0
294
+ * @experimental
295
+ * @param context Message to send to subscribers and bind to stores
296
+ * @param fn Handler to run within the entered storage context
297
+ * @param thisArg The receiver to be used for the function call.
298
+ * @param args Optional arguments to pass to the function.
299
+ */
300
+ runStores(): void;
301
+ }
302
+ interface TracingChannelSubscribers<ContextType extends object> {
303
+ start: (message: ContextType) => void;
304
+ end: (
305
+ message: ContextType & {
306
+ error?: unknown;
307
+ result?: unknown;
308
+ },
309
+ ) => void;
310
+ asyncStart: (
311
+ message: ContextType & {
312
+ error?: unknown;
313
+ result?: unknown;
314
+ },
315
+ ) => void;
316
+ asyncEnd: (
317
+ message: ContextType & {
318
+ error?: unknown;
319
+ result?: unknown;
320
+ },
321
+ ) => void;
322
+ error: (
323
+ message: ContextType & {
324
+ error: unknown;
325
+ },
326
+ ) => void;
327
+ }
328
+ interface TracingChannelCollection<StoreType = unknown, ContextType = StoreType> {
329
+ start: Channel<StoreType, ContextType>;
330
+ end: Channel<StoreType, ContextType>;
331
+ asyncStart: Channel<StoreType, ContextType>;
332
+ asyncEnd: Channel<StoreType, ContextType>;
333
+ error: Channel<StoreType, ContextType>;
334
+ }
335
+ /**
336
+ * The class `TracingChannel` is a collection of `TracingChannel Channels` which
337
+ * together express a single traceable action. It is used to formalize and
338
+ * simplify the process of producing events for tracing application flow.{@link tracingChannel} is used to construct a`TracingChannel`. As with `Channel` it is recommended to create and reuse a
339
+ * single `TracingChannel` at the top-level of the file rather than creating them
340
+ * dynamically.
341
+ * @since v19.9.0
342
+ * @experimental
343
+ */
344
+ class TracingChannel<StoreType = unknown, ContextType extends object = {}> implements TracingChannelCollection {
345
+ start: Channel<StoreType, ContextType>;
346
+ end: Channel<StoreType, ContextType>;
347
+ asyncStart: Channel<StoreType, ContextType>;
348
+ asyncEnd: Channel<StoreType, ContextType>;
349
+ error: Channel<StoreType, ContextType>;
350
+ /**
351
+ * Helper to subscribe a collection of functions to the corresponding channels.
352
+ * This is the same as calling `channel.subscribe(onMessage)` on each channel
353
+ * individually.
354
+ *
355
+ * ```js
356
+ * import diagnostics_channel from 'node:diagnostics_channel';
357
+ *
358
+ * const channels = diagnostics_channel.tracingChannel('my-channel');
359
+ *
360
+ * channels.subscribe({
361
+ * start(message) {
362
+ * // Handle start message
363
+ * },
364
+ * end(message) {
365
+ * // Handle end message
366
+ * },
367
+ * asyncStart(message) {
368
+ * // Handle asyncStart message
369
+ * },
370
+ * asyncEnd(message) {
371
+ * // Handle asyncEnd message
372
+ * },
373
+ * error(message) {
374
+ * // Handle error message
375
+ * },
376
+ * });
377
+ * ```
378
+ * @since v19.9.0
379
+ * @experimental
380
+ * @param subscribers Set of `TracingChannel Channels` subscribers
381
+ */
382
+ subscribe(subscribers: TracingChannelSubscribers<ContextType>): void;
383
+ /**
384
+ * Helper to unsubscribe a collection of functions from the corresponding channels.
385
+ * This is the same as calling `channel.unsubscribe(onMessage)` on each channel
386
+ * individually.
387
+ *
388
+ * ```js
389
+ * import diagnostics_channel from 'node:diagnostics_channel';
390
+ *
391
+ * const channels = diagnostics_channel.tracingChannel('my-channel');
392
+ *
393
+ * channels.unsubscribe({
394
+ * start(message) {
395
+ * // Handle start message
396
+ * },
397
+ * end(message) {
398
+ * // Handle end message
399
+ * },
400
+ * asyncStart(message) {
401
+ * // Handle asyncStart message
402
+ * },
403
+ * asyncEnd(message) {
404
+ * // Handle asyncEnd message
405
+ * },
406
+ * error(message) {
407
+ * // Handle error message
408
+ * },
409
+ * });
410
+ * ```
411
+ * @since v19.9.0
412
+ * @experimental
413
+ * @param subscribers Set of `TracingChannel Channels` subscribers
414
+ * @return `true` if all handlers were successfully unsubscribed, and `false` otherwise.
415
+ */
416
+ unsubscribe(subscribers: TracingChannelSubscribers<ContextType>): void;
417
+ /**
418
+ * Trace a synchronous function call. This will always produce a `start event` and `end event` around the execution and may produce an `error event` if the given function throws an error.
419
+ * This will run the given function using `channel.runStores(context, ...)` on the `start` channel which ensures all
420
+ * events should have any bound stores set to match this trace context.
421
+ *
422
+ * ```js
423
+ * import diagnostics_channel from 'node:diagnostics_channel';
424
+ *
425
+ * const channels = diagnostics_channel.tracingChannel('my-channel');
426
+ *
427
+ * channels.traceSync(() => {
428
+ * // Do something
429
+ * }, {
430
+ * some: 'thing',
431
+ * });
432
+ * ```
433
+ * @since v19.9.0
434
+ * @experimental
435
+ * @param fn Function to wrap a trace around
436
+ * @param context Shared object to correlate events through
437
+ * @param thisArg The receiver to be used for the function call
438
+ * @param args Optional arguments to pass to the function
439
+ * @return The return value of the given function
440
+ */
441
+ traceSync<ThisArg = any, Args extends any[] = any[]>(
442
+ fn: (this: ThisArg, ...args: Args) => any,
443
+ context?: ContextType,
444
+ thisArg?: ThisArg,
445
+ ...args: Args
446
+ ): void;
447
+ /**
448
+ * Trace a promise-returning function call. This will always produce a `start event` and `end event` around the synchronous portion of the
449
+ * function execution, and will produce an `asyncStart event` and `asyncEnd event` when a promise continuation is reached. It may also
450
+ * produce an `error event` if the given function throws an error or the
451
+ * returned promise rejects. This will run the given function using `channel.runStores(context, ...)` on the `start` channel which ensures all
452
+ * events should have any bound stores set to match this trace context.
453
+ *
454
+ * ```js
455
+ * import diagnostics_channel from 'node:diagnostics_channel';
456
+ *
457
+ * const channels = diagnostics_channel.tracingChannel('my-channel');
458
+ *
459
+ * channels.tracePromise(async () => {
460
+ * // Do something
461
+ * }, {
462
+ * some: 'thing',
463
+ * });
464
+ * ```
465
+ * @since v19.9.0
466
+ * @experimental
467
+ * @param fn Promise-returning function to wrap a trace around
468
+ * @param context Shared object to correlate trace events through
469
+ * @param thisArg The receiver to be used for the function call
470
+ * @param args Optional arguments to pass to the function
471
+ * @return Chained from promise returned by the given function
472
+ */
473
+ tracePromise<ThisArg = any, Args extends any[] = any[]>(
474
+ fn: (this: ThisArg, ...args: Args) => Promise<any>,
475
+ context?: ContextType,
476
+ thisArg?: ThisArg,
477
+ ...args: Args
478
+ ): void;
479
+ /**
480
+ * Trace a callback-receiving function call. This will always produce a `start event` and `end event` around the synchronous portion of the
481
+ * function execution, and will produce a `asyncStart event` and `asyncEnd event` around the callback execution. It may also produce an `error event` if the given function throws an error or
482
+ * the returned
483
+ * promise rejects. This will run the given function using `channel.runStores(context, ...)` on the `start` channel which ensures all
484
+ * events should have any bound stores set to match this trace context.
485
+ *
486
+ * The `position` will be -1 by default to indicate the final argument should
487
+ * be used as the callback.
488
+ *
489
+ * ```js
490
+ * import diagnostics_channel from 'node:diagnostics_channel';
491
+ *
492
+ * const channels = diagnostics_channel.tracingChannel('my-channel');
493
+ *
494
+ * channels.traceCallback((arg1, callback) => {
495
+ * // Do something
496
+ * callback(null, 'result');
497
+ * }, 1, {
498
+ * some: 'thing',
499
+ * }, thisArg, arg1, callback);
500
+ * ```
501
+ *
502
+ * The callback will also be run with `channel.runStores(context, ...)` which
503
+ * enables context loss recovery in some cases.
504
+ *
505
+ * ```js
506
+ * import diagnostics_channel from 'node:diagnostics_channel';
507
+ * import { AsyncLocalStorage } from 'node:async_hooks';
508
+ *
509
+ * const channels = diagnostics_channel.tracingChannel('my-channel');
510
+ * const myStore = new AsyncLocalStorage();
511
+ *
512
+ * // The start channel sets the initial store data to something
513
+ * // and stores that store data value on the trace context object
514
+ * channels.start.bindStore(myStore, (data) => {
515
+ * const span = new Span(data);
516
+ * data.span = span;
517
+ * return span;
518
+ * });
519
+ *
520
+ * // Then asyncStart can restore from that data it stored previously
521
+ * channels.asyncStart.bindStore(myStore, (data) => {
522
+ * return data.span;
523
+ * });
524
+ * ```
525
+ * @since v19.9.0
526
+ * @experimental
527
+ * @param fn callback using function to wrap a trace around
528
+ * @param position Zero-indexed argument position of expected callback
529
+ * @param context Shared object to correlate trace events through
530
+ * @param thisArg The receiver to be used for the function call
531
+ * @param args Optional arguments to pass to the function
532
+ * @return The return value of the given function
533
+ */
534
+ traceCallback<Fn extends (this: any, ...args: any) => any>(
535
+ fn: Fn,
536
+ position: number | undefined,
537
+ context: ContextType | undefined,
538
+ thisArg: any,
539
+ ...args: Parameters<Fn>
540
+ ): void;
187
541
  }
188
542
  }
189
543
  declare module "node:diagnostics_channel" {
@@ -9,12 +9,12 @@
9
9
  *
10
10
  * HTTP message headers are represented by an object like this:
11
11
  *
12
- * ```js
13
- * { 'content-length': '123',
14
- * 'content-type': 'text/plain',
15
- * 'connection': 'keep-alive',
16
- * 'host': 'example.com',
17
- * 'accept': '*' }
12
+ * ```json
13
+ * { "content-length": "123",
14
+ * "content-type": "text/plain",
15
+ * "connection": "keep-alive",
16
+ * "host": "example.com",
17
+ * "accept": "*" }
18
18
  * ```
19
19
  *
20
20
  * Keys are lowercased. Values are not modified.
@@ -1814,7 +1814,6 @@ declare module "http" {
1814
1814
  *
1815
1815
  * It is not necessary to use this method before passing headers to an HTTP request
1816
1816
  * or response. The HTTP module will automatically validate such headers.
1817
- * Examples:
1818
1817
  *
1819
1818
  * Example:
1820
1819
  *
@@ -276,6 +276,20 @@ declare module "module" {
276
276
  }
277
277
  global {
278
278
  interface ImportMeta {
279
+ /**
280
+ * The directory name of the current module. This is the same as the `path.dirname()` of the `import.meta.filename`.
281
+ * **Caveat:** only present on `file:` modules.
282
+ */
283
+ dirname?: string;
284
+ /**
285
+ * The full absolute path and filename of the current module, with symlinks resolved.
286
+ * This is the same as the `url.fileURLToPath()` of the `import.meta.url`.
287
+ * **Caveat:** only local modules support this property. Modules not using the `file:` protocol will not provide it.
288
+ */
289
+ filename?: string;
290
+ /**
291
+ * The absolute `file:` URL of the module.
292
+ */
279
293
  url: string;
280
294
  /**
281
295
  * Provides a module-relative resolution function scoped to each module, returning