@struct-ai/sdk 0.1.2 → 0.2.1

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