cloudstructs 0.6.48 → 0.6.49
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.
- package/.jsii +3 -3
- package/assets/slack-textract/detect.lambda/index.js +10 -4
- package/lib/codecommit-mirror/index.js +2 -2
- package/lib/dmarc/index.js +1 -1
- package/lib/ecs-service-roller/index.js +2 -2
- package/lib/email-receiver/receiver.js +1 -1
- package/lib/saml-identity-provider/index.js +2 -2
- package/lib/slack-app/manifest.js +1 -1
- package/lib/slack-app/slack-app.js +2 -2
- package/lib/slack-events/index.js +1 -1
- package/lib/slack-textract/index.js +1 -1
- package/lib/ssl-server-test/index.js +1 -1
- package/lib/state-machine-cr-provider/index.js +1 -1
- package/lib/static-website/index.js +1 -1
- package/lib/toolkit-cleaner/index.js +1 -1
- package/lib/url-shortener/index.js +1 -1
- package/node_modules/@slack/logger/node_modules/@types/node/README.md +1 -1
- package/node_modules/@slack/logger/node_modules/@types/node/buffer.d.ts +1 -1
- package/node_modules/@slack/logger/node_modules/@types/node/crypto.d.ts +21 -4
- package/node_modules/@slack/logger/node_modules/@types/node/dgram.d.ts +10 -0
- package/node_modules/@slack/logger/node_modules/@types/node/diagnostics_channel.d.ts +355 -1
- package/node_modules/@slack/logger/node_modules/@types/node/http.d.ts +6 -7
- package/node_modules/@slack/logger/node_modules/@types/node/module.d.ts +14 -0
- package/node_modules/@slack/logger/node_modules/@types/node/package.json +2 -2
- package/node_modules/@slack/logger/node_modules/@types/node/perf_hooks.d.ts +12 -6
- package/node_modules/@slack/logger/node_modules/@types/node/process.d.ts +25 -3
- package/node_modules/@slack/logger/node_modules/@types/node/querystring.d.ts +3 -3
- package/node_modules/@slack/logger/node_modules/@types/node/stream/web.d.ts +17 -1
- package/node_modules/@slack/logger/node_modules/@types/node/test.d.ts +98 -15
- package/node_modules/@slack/logger/node_modules/@types/node/ts4.8/buffer.d.ts +1 -1
- package/node_modules/@slack/logger/node_modules/@types/node/ts4.8/crypto.d.ts +21 -4
- package/node_modules/@slack/logger/node_modules/@types/node/ts4.8/dgram.d.ts +10 -0
- package/node_modules/@slack/logger/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +355 -1
- package/node_modules/@slack/logger/node_modules/@types/node/ts4.8/http.d.ts +6 -7
- package/node_modules/@slack/logger/node_modules/@types/node/ts4.8/module.d.ts +14 -0
- package/node_modules/@slack/logger/node_modules/@types/node/ts4.8/perf_hooks.d.ts +13 -7
- package/node_modules/@slack/logger/node_modules/@types/node/ts4.8/process.d.ts +25 -3
- package/node_modules/@slack/logger/node_modules/@types/node/ts4.8/querystring.d.ts +3 -3
- package/node_modules/@slack/logger/node_modules/@types/node/ts4.8/stream/web.d.ts +17 -1
- package/node_modules/@slack/logger/node_modules/@types/node/ts4.8/test.d.ts +98 -15
- package/node_modules/@slack/logger/node_modules/@types/node/ts4.8/wasi.d.ts +9 -5
- package/node_modules/@slack/logger/node_modules/@types/node/wasi.d.ts +9 -5
- package/node_modules/@slack/web-api/node_modules/@types/node/README.md +1 -1
- package/node_modules/@slack/web-api/node_modules/@types/node/buffer.d.ts +1 -1
- package/node_modules/@slack/web-api/node_modules/@types/node/crypto.d.ts +21 -4
- package/node_modules/@slack/web-api/node_modules/@types/node/dgram.d.ts +10 -0
- package/node_modules/@slack/web-api/node_modules/@types/node/diagnostics_channel.d.ts +355 -1
- package/node_modules/@slack/web-api/node_modules/@types/node/http.d.ts +6 -7
- package/node_modules/@slack/web-api/node_modules/@types/node/module.d.ts +14 -0
- package/node_modules/@slack/web-api/node_modules/@types/node/package.json +2 -2
- package/node_modules/@slack/web-api/node_modules/@types/node/perf_hooks.d.ts +12 -6
- package/node_modules/@slack/web-api/node_modules/@types/node/process.d.ts +25 -3
- package/node_modules/@slack/web-api/node_modules/@types/node/querystring.d.ts +3 -3
- package/node_modules/@slack/web-api/node_modules/@types/node/stream/web.d.ts +17 -1
- package/node_modules/@slack/web-api/node_modules/@types/node/test.d.ts +98 -15
- package/node_modules/@slack/web-api/node_modules/@types/node/ts4.8/buffer.d.ts +1 -1
- package/node_modules/@slack/web-api/node_modules/@types/node/ts4.8/crypto.d.ts +21 -4
- package/node_modules/@slack/web-api/node_modules/@types/node/ts4.8/dgram.d.ts +10 -0
- package/node_modules/@slack/web-api/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +355 -1
- package/node_modules/@slack/web-api/node_modules/@types/node/ts4.8/http.d.ts +6 -7
- package/node_modules/@slack/web-api/node_modules/@types/node/ts4.8/module.d.ts +14 -0
- package/node_modules/@slack/web-api/node_modules/@types/node/ts4.8/perf_hooks.d.ts +13 -7
- package/node_modules/@slack/web-api/node_modules/@types/node/ts4.8/process.d.ts +25 -3
- package/node_modules/@slack/web-api/node_modules/@types/node/ts4.8/querystring.d.ts +3 -3
- package/node_modules/@slack/web-api/node_modules/@types/node/ts4.8/stream/web.d.ts +17 -1
- package/node_modules/@slack/web-api/node_modules/@types/node/ts4.8/test.d.ts +98 -15
- package/node_modules/@slack/web-api/node_modules/@types/node/ts4.8/wasi.d.ts +9 -5
- package/node_modules/@slack/web-api/node_modules/@types/node/wasi.d.ts +9 -5
- package/node_modules/@slack/web-api/package.json +2 -2
- package/node_modules/@types/cacheable-request/node_modules/@types/node/README.md +1 -1
- package/node_modules/@types/cacheable-request/node_modules/@types/node/buffer.d.ts +1 -1
- package/node_modules/@types/cacheable-request/node_modules/@types/node/crypto.d.ts +21 -4
- package/node_modules/@types/cacheable-request/node_modules/@types/node/dgram.d.ts +10 -0
- package/node_modules/@types/cacheable-request/node_modules/@types/node/diagnostics_channel.d.ts +355 -1
- package/node_modules/@types/cacheable-request/node_modules/@types/node/http.d.ts +6 -7
- package/node_modules/@types/cacheable-request/node_modules/@types/node/module.d.ts +14 -0
- package/node_modules/@types/cacheable-request/node_modules/@types/node/package.json +2 -2
- package/node_modules/@types/cacheable-request/node_modules/@types/node/perf_hooks.d.ts +12 -6
- package/node_modules/@types/cacheable-request/node_modules/@types/node/process.d.ts +25 -3
- package/node_modules/@types/cacheable-request/node_modules/@types/node/querystring.d.ts +3 -3
- package/node_modules/@types/cacheable-request/node_modules/@types/node/stream/web.d.ts +17 -1
- package/node_modules/@types/cacheable-request/node_modules/@types/node/test.d.ts +98 -15
- package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/buffer.d.ts +1 -1
- package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/crypto.d.ts +21 -4
- package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/dgram.d.ts +10 -0
- package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +355 -1
- package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/http.d.ts +6 -7
- package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/module.d.ts +14 -0
- package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/perf_hooks.d.ts +13 -7
- package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/process.d.ts +25 -3
- package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/querystring.d.ts +3 -3
- package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/stream/web.d.ts +17 -1
- package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/test.d.ts +98 -15
- package/node_modules/@types/cacheable-request/node_modules/@types/node/ts4.8/wasi.d.ts +9 -5
- package/node_modules/@types/cacheable-request/node_modules/@types/node/wasi.d.ts +9 -5
- package/node_modules/@types/is-stream/node_modules/@types/node/README.md +1 -1
- package/node_modules/@types/is-stream/node_modules/@types/node/buffer.d.ts +1 -1
- package/node_modules/@types/is-stream/node_modules/@types/node/crypto.d.ts +21 -4
- package/node_modules/@types/is-stream/node_modules/@types/node/dgram.d.ts +10 -0
- package/node_modules/@types/is-stream/node_modules/@types/node/diagnostics_channel.d.ts +355 -1
- package/node_modules/@types/is-stream/node_modules/@types/node/http.d.ts +6 -7
- package/node_modules/@types/is-stream/node_modules/@types/node/module.d.ts +14 -0
- package/node_modules/@types/is-stream/node_modules/@types/node/package.json +2 -2
- package/node_modules/@types/is-stream/node_modules/@types/node/perf_hooks.d.ts +12 -6
- package/node_modules/@types/is-stream/node_modules/@types/node/process.d.ts +25 -3
- package/node_modules/@types/is-stream/node_modules/@types/node/querystring.d.ts +3 -3
- package/node_modules/@types/is-stream/node_modules/@types/node/stream/web.d.ts +17 -1
- package/node_modules/@types/is-stream/node_modules/@types/node/test.d.ts +98 -15
- package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/buffer.d.ts +1 -1
- package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/crypto.d.ts +21 -4
- package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/dgram.d.ts +10 -0
- package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +355 -1
- package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/http.d.ts +6 -7
- package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/module.d.ts +14 -0
- package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/perf_hooks.d.ts +13 -7
- package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/process.d.ts +25 -3
- package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/querystring.d.ts +3 -3
- package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/stream/web.d.ts +17 -1
- package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/test.d.ts +98 -15
- package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/wasi.d.ts +9 -5
- package/node_modules/@types/is-stream/node_modules/@types/node/wasi.d.ts +9 -5
- package/node_modules/@types/keyv/node_modules/@types/node/README.md +1 -1
- package/node_modules/@types/keyv/node_modules/@types/node/buffer.d.ts +1 -1
- package/node_modules/@types/keyv/node_modules/@types/node/crypto.d.ts +21 -4
- package/node_modules/@types/keyv/node_modules/@types/node/dgram.d.ts +10 -0
- package/node_modules/@types/keyv/node_modules/@types/node/diagnostics_channel.d.ts +355 -1
- package/node_modules/@types/keyv/node_modules/@types/node/http.d.ts +6 -7
- package/node_modules/@types/keyv/node_modules/@types/node/module.d.ts +14 -0
- package/node_modules/@types/keyv/node_modules/@types/node/package.json +2 -2
- package/node_modules/@types/keyv/node_modules/@types/node/perf_hooks.d.ts +12 -6
- package/node_modules/@types/keyv/node_modules/@types/node/process.d.ts +25 -3
- package/node_modules/@types/keyv/node_modules/@types/node/querystring.d.ts +3 -3
- package/node_modules/@types/keyv/node_modules/@types/node/stream/web.d.ts +17 -1
- package/node_modules/@types/keyv/node_modules/@types/node/test.d.ts +98 -15
- package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/buffer.d.ts +1 -1
- package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/crypto.d.ts +21 -4
- package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/dgram.d.ts +10 -0
- package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +355 -1
- package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/http.d.ts +6 -7
- package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/module.d.ts +14 -0
- package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/perf_hooks.d.ts +13 -7
- package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/process.d.ts +25 -3
- package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/querystring.d.ts +3 -3
- package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/stream/web.d.ts +17 -1
- package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/test.d.ts +98 -15
- package/node_modules/@types/keyv/node_modules/@types/node/ts4.8/wasi.d.ts +9 -5
- package/node_modules/@types/keyv/node_modules/@types/node/wasi.d.ts +9 -5
- package/node_modules/@types/responselike/node_modules/@types/node/README.md +1 -1
- package/node_modules/@types/responselike/node_modules/@types/node/buffer.d.ts +1 -1
- package/node_modules/@types/responselike/node_modules/@types/node/crypto.d.ts +21 -4
- package/node_modules/@types/responselike/node_modules/@types/node/dgram.d.ts +10 -0
- package/node_modules/@types/responselike/node_modules/@types/node/diagnostics_channel.d.ts +355 -1
- package/node_modules/@types/responselike/node_modules/@types/node/http.d.ts +6 -7
- package/node_modules/@types/responselike/node_modules/@types/node/module.d.ts +14 -0
- package/node_modules/@types/responselike/node_modules/@types/node/package.json +2 -2
- package/node_modules/@types/responselike/node_modules/@types/node/perf_hooks.d.ts +12 -6
- package/node_modules/@types/responselike/node_modules/@types/node/process.d.ts +25 -3
- package/node_modules/@types/responselike/node_modules/@types/node/querystring.d.ts +3 -3
- package/node_modules/@types/responselike/node_modules/@types/node/stream/web.d.ts +17 -1
- package/node_modules/@types/responselike/node_modules/@types/node/test.d.ts +98 -15
- package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/buffer.d.ts +1 -1
- package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/crypto.d.ts +21 -4
- package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/dgram.d.ts +10 -0
- package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +355 -1
- package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/http.d.ts +6 -7
- package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/module.d.ts +14 -0
- package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/perf_hooks.d.ts +13 -7
- package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/process.d.ts +25 -3
- package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/querystring.d.ts +3 -3
- package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/stream/web.d.ts +17 -1
- package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/test.d.ts +98 -15
- package/node_modules/@types/responselike/node_modules/@types/node/ts4.8/wasi.d.ts +9 -5
- package/node_modules/@types/responselike/node_modules/@types/node/wasi.d.ts +9 -5
- package/node_modules/axios/CHANGELOG.md +27 -0
- package/node_modules/axios/README.md +37 -4
- package/node_modules/axios/dist/axios.js +3 -2
- package/node_modules/axios/dist/axios.js.map +1 -1
- package/node_modules/axios/dist/axios.min.js +1 -1
- package/node_modules/axios/dist/axios.min.js.map +1 -1
- package/node_modules/axios/dist/browser/axios.cjs +5 -2
- package/node_modules/axios/dist/browser/axios.cjs.map +1 -1
- package/node_modules/axios/dist/esm/axios.js +5 -2
- package/node_modules/axios/dist/esm/axios.js.map +1 -1
- package/node_modules/axios/dist/esm/axios.min.js +1 -1
- package/node_modules/axios/dist/esm/axios.min.js.map +1 -1
- package/node_modules/axios/dist/node/axios.cjs +9 -2
- package/node_modules/axios/dist/node/axios.cjs.map +1 -1
- package/node_modules/axios/lib/adapters/http.js +4 -0
- package/node_modules/axios/lib/env/data.js +1 -1
- package/node_modules/axios/lib/helpers/formDataToJSON.js +3 -0
- package/node_modules/axios/package.json +2 -2
- package/node_modules/follow-redirects/index.js +1 -0
- package/node_modules/follow-redirects/package.json +1 -1
- package/package.json +18 -18
- package/.gitattributes +0 -36
|
@@ -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';
|
|
@@ -1007,12 +1012,20 @@ declare module "node:test" {
|
|
|
1007
1012
|
*/
|
|
1008
1013
|
restore(): void;
|
|
1009
1014
|
}
|
|
1010
|
-
type Timer = "setInterval" | "
|
|
1015
|
+
type Timer = "setInterval" | "setTimeout" | "setImmediate" | "Date";
|
|
1016
|
+
|
|
1017
|
+
interface MockTimersOptions {
|
|
1018
|
+
apis: Timer[];
|
|
1019
|
+
now?: number | Date;
|
|
1020
|
+
}
|
|
1011
1021
|
/**
|
|
1012
1022
|
* Mocking timers is a technique commonly used in software testing to simulate and
|
|
1013
1023
|
* control the behavior of timers, such as `setInterval` and `setTimeout`,
|
|
1014
1024
|
* without actually waiting for the specified time intervals.
|
|
1015
1025
|
*
|
|
1026
|
+
* The MockTimers API also allows for mocking of the `Date` constructor and
|
|
1027
|
+
* `setImmediate`/`clearImmediate` functions.
|
|
1028
|
+
*
|
|
1016
1029
|
* The `MockTracker` provides a top-level `timers` export
|
|
1017
1030
|
* which is a `MockTimers` instance.
|
|
1018
1031
|
* @since v20.4.0
|
|
@@ -1025,24 +1038,66 @@ declare module "node:test" {
|
|
|
1025
1038
|
* **Note:** When you enable mocking for a specific timer, its associated
|
|
1026
1039
|
* clear function will also be implicitly mocked.
|
|
1027
1040
|
*
|
|
1028
|
-
*
|
|
1041
|
+
* **Note:** Mocking `Date` will affect the behavior of the mocked timers
|
|
1042
|
+
* as they use the same internal clock.
|
|
1043
|
+
*
|
|
1044
|
+
* Example usage without setting initial time:
|
|
1045
|
+
*
|
|
1046
|
+
* ```js
|
|
1047
|
+
* import { mock } from 'node:test';
|
|
1048
|
+
* mock.timers.enable({ apis: ['setInterval', 'Date'], now: 1234 });
|
|
1049
|
+
* ```
|
|
1050
|
+
*
|
|
1051
|
+
* The above example enables mocking for the `Date` constructor, `setInterval` timer and
|
|
1052
|
+
* implicitly mocks the `clearInterval` function. Only the `Date` constructor from `globalThis`,
|
|
1053
|
+
* `setInterval` and `clearInterval` functions from `node:timers`,`node:timers/promises`, and `globalThis` will be mocked.
|
|
1054
|
+
*
|
|
1055
|
+
* Example usage with initial time set
|
|
1029
1056
|
*
|
|
1030
1057
|
* ```js
|
|
1031
1058
|
* import { mock } from 'node:test';
|
|
1032
|
-
* mock.timers.enable(['
|
|
1059
|
+
* mock.timers.enable({ apis: ['Date'], now: 1000 });
|
|
1033
1060
|
* ```
|
|
1034
1061
|
*
|
|
1035
|
-
*
|
|
1036
|
-
*
|
|
1062
|
+
* Example usage with initial Date object as time set
|
|
1063
|
+
*
|
|
1064
|
+
* ```js
|
|
1065
|
+
* import { mock } from 'node:test';
|
|
1066
|
+
* mock.timers.enable({ apis: ['Date'], now: new Date() });
|
|
1067
|
+
* ```
|
|
1037
1068
|
*
|
|
1038
1069
|
* Alternatively, if you call `mock.timers.enable()` without any parameters:
|
|
1039
1070
|
*
|
|
1040
|
-
* All timers (`'setInterval'`, `'clearInterval'`, `'setTimeout'`, and `'clearTimeout'`)
|
|
1041
|
-
* will be mocked.
|
|
1071
|
+
* All timers (`'setInterval'`, `'clearInterval'`, `'Date'`, `'setImmediate'`, `'clearImmediate'`, `'setTimeout'`, and `'clearTimeout'`)
|
|
1072
|
+
* will be mocked.
|
|
1073
|
+
*
|
|
1074
|
+
* The `setInterval`, `clearInterval`, `setTimeout`, and `clearTimeout` functions from `node:timers`, `node:timers/promises`,
|
|
1042
1075
|
* and `globalThis` will be mocked.
|
|
1076
|
+
* The `Date` constructor from `globalThis` will be mocked.
|
|
1077
|
+
*
|
|
1078
|
+
* If there is no initial epoch set, the initial date will be based on 0 in the Unix epoch. This is `January 1st, 1970, 00:00:00 UTC`. You can set an initial date by passing a now property to the `.enable()` method. This value will be used as the initial date for the mocked Date object. It can either be a positive integer, or another Date object.
|
|
1043
1079
|
* @since v20.4.0
|
|
1044
1080
|
*/
|
|
1045
|
-
enable(
|
|
1081
|
+
enable(options?: MockTimersOptions): void;
|
|
1082
|
+
/**
|
|
1083
|
+
* You can use the `.setTime()` method to manually move the mocked date to another time. This method only accepts a positive integer.
|
|
1084
|
+
* Note: This method will execute any mocked timers that are in the past from the new time.
|
|
1085
|
+
* In the below example we are setting a new time for the mocked date.
|
|
1086
|
+
* ```js
|
|
1087
|
+
* import assert from 'node:assert';
|
|
1088
|
+
* import { test } from 'node:test';
|
|
1089
|
+
* test('sets the time of a date object', (context) => {
|
|
1090
|
+
* // Optionally choose what to mock
|
|
1091
|
+
* context.mock.timers.enable({ apis: ['Date'], now: 100 });
|
|
1092
|
+
* assert.strictEqual(Date.now(), 100);
|
|
1093
|
+
* // Advance in time will also advance the date
|
|
1094
|
+
* context.mock.timers.setTime(1000);
|
|
1095
|
+
* context.mock.timers.tick(200);
|
|
1096
|
+
* assert.strictEqual(Date.now(), 1200);
|
|
1097
|
+
* });
|
|
1098
|
+
* ```
|
|
1099
|
+
*/
|
|
1100
|
+
setTime(time: number): void;
|
|
1046
1101
|
/**
|
|
1047
1102
|
* This function restores the default behavior of all mocks that were previously
|
|
1048
1103
|
* created by this `MockTimers` instance and disassociates the mocks
|
|
@@ -1076,7 +1131,7 @@ declare module "node:test" {
|
|
|
1076
1131
|
* test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
|
|
1077
1132
|
* const fn = context.mock.fn();
|
|
1078
1133
|
*
|
|
1079
|
-
* context.mock.timers.enable(['setTimeout']);
|
|
1134
|
+
* context.mock.timers.enable({ apis: ['setTimeout'] });
|
|
1080
1135
|
*
|
|
1081
1136
|
* setTimeout(fn, 9999);
|
|
1082
1137
|
*
|
|
@@ -1097,7 +1152,7 @@ declare module "node:test" {
|
|
|
1097
1152
|
*
|
|
1098
1153
|
* test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
|
|
1099
1154
|
* const fn = context.mock.fn();
|
|
1100
|
-
* context.mock.timers.enable(['setTimeout']);
|
|
1155
|
+
* context.mock.timers.enable({ apis: ['setTimeout'] });
|
|
1101
1156
|
* const nineSecs = 9000;
|
|
1102
1157
|
* setTimeout(fn, nineSecs);
|
|
1103
1158
|
*
|
|
@@ -1109,11 +1164,35 @@ declare module "node:test" {
|
|
|
1109
1164
|
* assert.strictEqual(fn.mock.callCount(), 1);
|
|
1110
1165
|
* });
|
|
1111
1166
|
* ```
|
|
1167
|
+
*
|
|
1168
|
+
* Advancing time using `.tick` will also advance the time for any `Date` object
|
|
1169
|
+
* created after the mock was enabled (if `Date` was also set to be mocked).
|
|
1170
|
+
*
|
|
1171
|
+
* ```js
|
|
1172
|
+
* import assert from 'node:assert';
|
|
1173
|
+
* import { test } from 'node:test';
|
|
1174
|
+
*
|
|
1175
|
+
* test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
|
|
1176
|
+
* const fn = context.mock.fn();
|
|
1177
|
+
*
|
|
1178
|
+
* context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
|
|
1179
|
+
* setTimeout(fn, 9999);
|
|
1180
|
+
*
|
|
1181
|
+
* assert.strictEqual(fn.mock.callCount(), 0);
|
|
1182
|
+
* assert.strictEqual(Date.now(), 0);
|
|
1183
|
+
*
|
|
1184
|
+
* // Advance in time
|
|
1185
|
+
* context.mock.timers.tick(9999);
|
|
1186
|
+
* assert.strictEqual(fn.mock.callCount(), 1);
|
|
1187
|
+
* assert.strictEqual(Date.now(), 9999);
|
|
1188
|
+
* });
|
|
1189
|
+
* ```
|
|
1112
1190
|
* @since v20.4.0
|
|
1113
1191
|
*/
|
|
1114
1192
|
tick(milliseconds: number): void;
|
|
1115
1193
|
/**
|
|
1116
|
-
* Triggers all pending mocked timers immediately.
|
|
1194
|
+
* Triggers all pending mocked timers immediately. If the `Date` object is also
|
|
1195
|
+
* mocked, it will also advance the `Date` object to the furthest timer's time.
|
|
1117
1196
|
*
|
|
1118
1197
|
* The example below triggers all pending timers immediately,
|
|
1119
1198
|
* causing them to execute without any delay.
|
|
@@ -1123,7 +1202,7 @@ declare module "node:test" {
|
|
|
1123
1202
|
* import { test } from 'node:test';
|
|
1124
1203
|
*
|
|
1125
1204
|
* test('runAll functions following the given order', (context) => {
|
|
1126
|
-
* context.mock.timers.enable(['setTimeout']);
|
|
1205
|
+
* context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
|
|
1127
1206
|
* const results = [];
|
|
1128
1207
|
* setTimeout(() => results.push(1), 9999);
|
|
1129
1208
|
*
|
|
@@ -1135,8 +1214,9 @@ declare module "node:test" {
|
|
|
1135
1214
|
* assert.deepStrictEqual(results, []);
|
|
1136
1215
|
*
|
|
1137
1216
|
* context.mock.timers.runAll();
|
|
1138
|
-
*
|
|
1139
1217
|
* assert.deepStrictEqual(results, [3, 2, 1]);
|
|
1218
|
+
* // The Date object is also advanced to the furthest timer's time
|
|
1219
|
+
* assert.strictEqual(Date.now(), 9999);
|
|
1140
1220
|
* });
|
|
1141
1221
|
* ```
|
|
1142
1222
|
*
|
|
@@ -1343,7 +1423,7 @@ interface TestDequeue extends TestLocationInfo {
|
|
|
1343
1423
|
* @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/test/reporters.js)
|
|
1344
1424
|
*/
|
|
1345
1425
|
declare module "node:test/reporters" {
|
|
1346
|
-
import { Transform } from "node:stream";
|
|
1426
|
+
import { Transform, TransformOptions } from "node:stream";
|
|
1347
1427
|
|
|
1348
1428
|
type TestEvent =
|
|
1349
1429
|
| { type: "test:diagnostic"; data: DiagnosticData }
|
|
@@ -1378,5 +1458,8 @@ declare module "node:test/reporters" {
|
|
|
1378
1458
|
* The `junit` reporter outputs test results in a jUnit XML format
|
|
1379
1459
|
*/
|
|
1380
1460
|
function junit(source: TestEventGenerator): AsyncGenerator<string, void>;
|
|
1381
|
-
|
|
1461
|
+
class Lcov extends Transform {
|
|
1462
|
+
constructor(opts?: TransformOptions);
|
|
1463
|
+
}
|
|
1464
|
+
export { dot, junit, Lcov as lcov, Spec as spec, tap, TestEvent };
|
|
1382
1465
|
}
|
|
@@ -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
|
|
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)`.
|
|
@@ -100,6 +100,8 @@ declare module "crypto" {
|
|
|
100
100
|
const OPENSSL_VERSION_NUMBER: number;
|
|
101
101
|
/** Applies multiple bug workarounds within OpenSSL. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html for detail. */
|
|
102
102
|
const SSL_OP_ALL: number;
|
|
103
|
+
/** Instructs OpenSSL to allow a non-[EC]DHE-based key exchange mode for TLS v1.3 */
|
|
104
|
+
const SSL_OP_ALLOW_NO_DHE_KEX: number;
|
|
103
105
|
/** Allows legacy insecure renegotiation between OpenSSL and unpatched clients or servers. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html. */
|
|
104
106
|
const SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number;
|
|
105
107
|
/** Attempts to use the server's preferences instead of the client's when selecting a cipher. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html. */
|
|
@@ -116,15 +118,29 @@ declare module "crypto" {
|
|
|
116
118
|
const SSL_OP_LEGACY_SERVER_CONNECT: number;
|
|
117
119
|
/** Instructs OpenSSL to disable support for SSL/TLS compression. */
|
|
118
120
|
const SSL_OP_NO_COMPRESSION: number;
|
|
121
|
+
/** Instructs OpenSSL to disable encrypt-then-MAC. */
|
|
122
|
+
const SSL_OP_NO_ENCRYPT_THEN_MAC: number;
|
|
119
123
|
const SSL_OP_NO_QUERY_MTU: number;
|
|
124
|
+
/** Instructs OpenSSL to disable renegotiation. */
|
|
125
|
+
const SSL_OP_NO_RENEGOTIATION: number;
|
|
120
126
|
/** Instructs OpenSSL to always start a new session when performing renegotiation. */
|
|
121
127
|
const SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number;
|
|
128
|
+
/** Instructs OpenSSL to turn off SSL v2 */
|
|
122
129
|
const SSL_OP_NO_SSLv2: number;
|
|
130
|
+
/** Instructs OpenSSL to turn off SSL v3 */
|
|
123
131
|
const SSL_OP_NO_SSLv3: number;
|
|
132
|
+
/** Instructs OpenSSL to disable use of RFC4507bis tickets. */
|
|
124
133
|
const SSL_OP_NO_TICKET: number;
|
|
134
|
+
/** Instructs OpenSSL to turn off TLS v1 */
|
|
125
135
|
const SSL_OP_NO_TLSv1: number;
|
|
136
|
+
/** Instructs OpenSSL to turn off TLS v1.1 */
|
|
126
137
|
const SSL_OP_NO_TLSv1_1: number;
|
|
138
|
+
/** Instructs OpenSSL to turn off TLS v1.2 */
|
|
127
139
|
const SSL_OP_NO_TLSv1_2: number;
|
|
140
|
+
/** Instructs OpenSSL to turn off TLS v1.3 */
|
|
141
|
+
const SSL_OP_NO_TLSv1_3: number;
|
|
142
|
+
/** Instructs OpenSSL server to prioritize ChaCha20-Poly1305 when the client does. This option has no effect if `SSL_OP_CIPHER_SERVER_PREFERENCE` is not enabled. */
|
|
143
|
+
const SSL_OP_PRIORITIZE_CHACHA: number;
|
|
128
144
|
/** Instructs OpenSSL to disable version rollback attack detection. */
|
|
129
145
|
const SSL_OP_TLS_ROLLBACK_BUG: number;
|
|
130
146
|
const ENGINE_METHOD_RSA: number;
|
|
@@ -363,7 +379,7 @@ declare module "crypto" {
|
|
|
363
379
|
* @since v13.1.0
|
|
364
380
|
* @param options `stream.transform` options
|
|
365
381
|
*/
|
|
366
|
-
copy(options?:
|
|
382
|
+
copy(options?: HashOptions): Hash;
|
|
367
383
|
/**
|
|
368
384
|
* Updates the hash content with the given `data`, the encoding of which
|
|
369
385
|
* is given in `inputEncoding`.
|
|
@@ -638,9 +654,10 @@ declare module "crypto" {
|
|
|
638
654
|
export(options?: KeyExportOptions<"der">): Buffer;
|
|
639
655
|
export(options?: JwkKeyExportOptions): JsonWebKey;
|
|
640
656
|
/**
|
|
641
|
-
* Returns `true` or `false` depending on whether the keys have exactly the same
|
|
642
|
-
* This method is not [constant time](https://en.wikipedia.org/wiki/Timing_attack).
|
|
643
|
-
* @since v16.15.0
|
|
657
|
+
* Returns `true` or `false` depending on whether the keys have exactly the same
|
|
658
|
+
* type, value, and parameters. This method is not [constant time](https://en.wikipedia.org/wiki/Timing_attack).
|
|
659
|
+
* @since v17.7.0, v16.15.0
|
|
660
|
+
* @param otherKeyObject A `KeyObject` with which to compare `keyObject`.
|
|
644
661
|
*/
|
|
645
662
|
equals(otherKeyObject: KeyObject): boolean;
|
|
646
663
|
/**
|
|
@@ -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 Number of bytes queued for sending.
|
|
233
|
+
*/
|
|
234
|
+
getSendQueueSize(): number;
|
|
235
|
+
/**
|
|
236
|
+
* @since v18.8.0, v16.19.0
|
|
237
|
+
* @return 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
|
package/node_modules/@types/is-stream/node_modules/@types/node/ts4.8/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" {
|