@types/node 20.10.6 → 20.10.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.
- node/README.md +1 -1
- node/dgram.d.ts +10 -0
- node/diagnostics_channel.d.ts +355 -1
- node/package.json +2 -2
- node/ts4.8/dgram.d.ts +10 -0
- node/ts4.8/diagnostics_channel.d.ts +355 -1
node/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Tue, 09 Jan 2024 15:35:40 GMT
|
|
12
12
|
* Dependencies: [undici-types](https://npmjs.com/package/undici-types)
|
|
13
13
|
|
|
14
14
|
# Credits
|
node/dgram.d.ts
CHANGED
|
@@ -227,6 +227,16 @@ declare module "dgram" {
|
|
|
227
227
|
* @return the `SO_SNDBUF` socket send buffer size in bytes.
|
|
228
228
|
*/
|
|
229
229
|
getSendBufferSize(): number;
|
|
230
|
+
/**
|
|
231
|
+
* @since v18.8.0,v16.19.0
|
|
232
|
+
* @return the number of bytes queued for sending.
|
|
233
|
+
*/
|
|
234
|
+
getSendQueueSize(): number;
|
|
235
|
+
/**
|
|
236
|
+
* @since v18.8.0,v16.19.0
|
|
237
|
+
* @return the number of send requests currently in the queue awaiting to be processed.
|
|
238
|
+
*/
|
|
239
|
+
getSendQueueCount(): number;
|
|
230
240
|
/**
|
|
231
241
|
* By default, binding a socket will cause it to block the Node.js process from
|
|
232
242
|
* exiting as long as the socket is open. The `socket.unref()` method can be used
|
node/diagnostics_channel.d.ts
CHANGED
|
@@ -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" {
|
node/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/node",
|
|
3
|
-
"version": "20.10.
|
|
3
|
+
"version": "20.10.8",
|
|
4
4
|
"description": "TypeScript definitions for node",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
|
|
6
6
|
"license": "MIT",
|
|
@@ -224,7 +224,7 @@
|
|
|
224
224
|
"dependencies": {
|
|
225
225
|
"undici-types": "~5.26.4"
|
|
226
226
|
},
|
|
227
|
-
"typesPublisherContentHash": "
|
|
227
|
+
"typesPublisherContentHash": "81a6ffec7851a9499bdc79517eb318d5db43383eae84c65f2509a4319d302d31",
|
|
228
228
|
"typeScriptVersion": "4.6",
|
|
229
229
|
"nonNpm": true
|
|
230
230
|
}
|
node/ts4.8/dgram.d.ts
CHANGED
|
@@ -227,6 +227,16 @@ declare module "dgram" {
|
|
|
227
227
|
* @return the `SO_SNDBUF` socket send buffer size in bytes.
|
|
228
228
|
*/
|
|
229
229
|
getSendBufferSize(): number;
|
|
230
|
+
/**
|
|
231
|
+
* @since v18.8.0,v16.19.0
|
|
232
|
+
* @return the number of bytes queued for sending.
|
|
233
|
+
*/
|
|
234
|
+
getSendQueueSize(): number;
|
|
235
|
+
/**
|
|
236
|
+
* @since v18.8.0,v16.19.0
|
|
237
|
+
* @return the number of send requests currently in the queue awaiting to be processed.
|
|
238
|
+
*/
|
|
239
|
+
getSendQueueCount(): number;
|
|
230
240
|
/**
|
|
231
241
|
* By default, binding a socket will cause it to block the Node.js process from
|
|
232
242
|
* exiting as long as the socket is open. The `socket.unref()` method can be used
|
|
@@ -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" {
|