@struct-ai/sdk 0.2.0 → 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 (190) hide show
  1. package/README.md +46 -3
  2. package/package.json +12 -12
  3. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/content-capture.d.ts +0 -10
  4. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/context.d.ts +0 -30
  5. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/core.d.ts +0 -120
  6. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/events.d.ts +0 -12
  7. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/index.d.ts +0 -6
  8. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/integrations/anthropic-content.d.ts +0 -24
  9. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/integrations/anthropic.d.ts +0 -34
  10. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/integrations/index.d.ts +0 -5
  11. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/integrations/langchain-callback.d.ts +0 -134
  12. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/integrations/langchain-content.d.ts +0 -35
  13. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/integrations/langchain.d.ts +0 -11
  14. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/package.json +0 -3
  15. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/semconv.d.ts +0 -54
  16. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/truncation.d.ts +0 -10
  17. package/dist/node_modules/@struct-ai/sdk/dist/esm/content-capture.d.ts +0 -10
  18. package/dist/node_modules/@struct-ai/sdk/dist/esm/context.d.ts +0 -30
  19. package/dist/node_modules/@struct-ai/sdk/dist/esm/core.d.ts +0 -120
  20. package/dist/node_modules/@struct-ai/sdk/dist/esm/events.d.ts +0 -12
  21. package/dist/node_modules/@struct-ai/sdk/dist/esm/index.d.ts +0 -6
  22. package/dist/node_modules/@struct-ai/sdk/dist/esm/integrations/anthropic-content.d.ts +0 -24
  23. package/dist/node_modules/@struct-ai/sdk/dist/esm/integrations/anthropic.d.ts +0 -34
  24. package/dist/node_modules/@struct-ai/sdk/dist/esm/integrations/index.d.ts +0 -5
  25. package/dist/node_modules/@struct-ai/sdk/dist/esm/integrations/langchain-callback.d.ts +0 -134
  26. package/dist/node_modules/@struct-ai/sdk/dist/esm/integrations/langchain-content.d.ts +0 -35
  27. package/dist/node_modules/@struct-ai/sdk/dist/esm/integrations/langchain.d.ts +0 -11
  28. package/dist/node_modules/@struct-ai/sdk/dist/esm/package.json +0 -3
  29. package/dist/node_modules/@struct-ai/sdk/dist/esm/semconv.d.ts +0 -54
  30. package/dist/node_modules/@struct-ai/sdk/dist/esm/truncation.d.ts +0 -10
  31. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/dist/commonjs/package.json +0 -3
  32. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/dist/esm/package.json +0 -3
  33. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/package.json +0 -103
  34. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/package.json +0 -103
  35. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/anthropic/package.json +0 -118
  36. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/package.json +0 -916
  37. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/package.json +0 -188
  38. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/openai/package.json +0 -105
  39. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/api/package.json +0 -96
  40. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/api-logs/package.json +0 -91
  41. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/core/package.json +0 -96
  42. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/exporter-logs-otlp-proto/package.json +0 -108
  43. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/exporter-trace-otlp-proto/package.json +0 -105
  44. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/resources/package.json +0 -100
  45. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/sdk-logs/package.json +0 -109
  46. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/sdk-trace-base/package.json +0 -100
  47. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/sdk-trace-node/package.json +0 -76
  48. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/package.json +0 -140
  49. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/nock/package.json +0 -89
  50. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/tshy/package.json +0 -81
  51. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/tsx/package.json +0 -68
  52. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/typescript/package.json +0 -120
  53. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/vitest/package.json +0 -239
  54. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/zod/package.json +0 -135
  55. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/package.json +0 -103
  56. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/core.d.ts +0 -244
  57. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/error.d.ts +0 -54
  58. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/index.d.ts +0 -188
  59. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/package.json +0 -103
  60. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/pagination.d.ts +0 -26
  61. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/resource.d.ts +0 -6
  62. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/streaming.d.ts +0 -41
  63. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/uploads.d.ts +0 -75
  64. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/version.d.ts +0 -2
  65. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/anthropic/experimental.d.ts +0 -1
  66. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/anthropic/index.d.ts +0 -1
  67. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/anthropic/package.json +0 -118
  68. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/agents.d.ts +0 -1
  69. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/caches.d.ts +0 -1
  70. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/chat_history.d.ts +0 -1
  71. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/context.d.ts +0 -1
  72. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/documents.d.ts +0 -1
  73. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/embeddings.d.ts +0 -1
  74. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/example_selectors.d.ts +0 -1
  75. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/index.d.ts +0 -1
  76. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/indexing.d.ts +0 -1
  77. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/load.d.ts +0 -1
  78. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/memory.d.ts +0 -1
  79. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/messages.d.ts +0 -1
  80. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/output_parsers.d.ts +0 -1
  81. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/outputs.d.ts +0 -1
  82. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/package.json +0 -916
  83. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/prompt_values.d.ts +0 -1
  84. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/prompts.d.ts +0 -1
  85. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/retrievers.d.ts +0 -1
  86. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/runnables.d.ts +0 -1
  87. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/singletons.d.ts +0 -1
  88. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/stores.d.ts +0 -1
  89. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/structured_query.d.ts +0 -1
  90. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/tools.d.ts +0 -1
  91. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/vectorstores.d.ts +0 -1
  92. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/index.d.ts +0 -1
  93. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/package.json +0 -188
  94. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/prebuilt.d.ts +0 -1
  95. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/pregel.d.ts +0 -1
  96. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/remote.d.ts +0 -1
  97. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/web.d.ts +0 -1
  98. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/zod.d.ts +0 -1
  99. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/openai/index.d.ts +0 -1
  100. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/openai/package.json +0 -105
  101. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/api/package.json +0 -96
  102. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/api-logs/package.json +0 -91
  103. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/core/package.json +0 -96
  104. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/exporter-logs-otlp-proto/package.json +0 -108
  105. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/exporter-trace-otlp-proto/package.json +0 -105
  106. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/resources/package.json +0 -100
  107. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/sdk-logs/package.json +0 -109
  108. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/sdk-trace-base/package.json +0 -100
  109. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/sdk-trace-node/package.json +0 -76
  110. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/assert.d.ts +0 -1062
  111. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/async_hooks.d.ts +0 -605
  112. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/buffer.buffer.d.ts +0 -471
  113. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/buffer.d.ts +0 -1936
  114. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/child_process.d.ts +0 -1475
  115. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/cluster.d.ts +0 -577
  116. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/console.d.ts +0 -452
  117. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/constants.d.ts +0 -21
  118. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/crypto.d.ts +0 -4590
  119. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/dgram.d.ts +0 -597
  120. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/diagnostics_channel.d.ts +0 -578
  121. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/dns.d.ts +0 -871
  122. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/domain.d.ts +0 -170
  123. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/events.d.ts +0 -977
  124. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/fs.d.ts +0 -4375
  125. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/globals.d.ts +0 -172
  126. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/globals.typedarray.d.ts +0 -38
  127. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/http.d.ts +0 -2049
  128. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/http2.d.ts +0 -2631
  129. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/https.d.ts +0 -578
  130. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/index.d.ts +0 -93
  131. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/inspector.generated.d.ts +0 -3966
  132. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/module.d.ts +0 -539
  133. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/net.d.ts +0 -1031
  134. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/os.d.ts +0 -506
  135. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/package.json +0 -140
  136. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/path.d.ts +0 -200
  137. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/perf_hooks.d.ts +0 -961
  138. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/process.d.ts +0 -1961
  139. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/punycode.d.ts +0 -117
  140. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/querystring.d.ts +0 -152
  141. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/readline.d.ts +0 -589
  142. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/repl.d.ts +0 -430
  143. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/sea.d.ts +0 -153
  144. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/stream.d.ts +0 -1698
  145. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/string_decoder.d.ts +0 -67
  146. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/test.d.ts +0 -1787
  147. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/timers.d.ts +0 -286
  148. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/tls.d.ts +0 -1259
  149. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/trace_events.d.ts +0 -197
  150. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/tty.d.ts +0 -208
  151. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/url.d.ts +0 -964
  152. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/util.d.ts +0 -2331
  153. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/v8.d.ts +0 -809
  154. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/vm.d.ts +0 -1001
  155. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/wasi.d.ts +0 -181
  156. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/worker_threads.d.ts +0 -715
  157. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/zlib.d.ts +0 -598
  158. package/dist/node_modules/@struct-ai/sdk/node_modules/nock/package.json +0 -89
  159. package/dist/node_modules/@struct-ai/sdk/node_modules/tshy/package.json +0 -81
  160. package/dist/node_modules/@struct-ai/sdk/node_modules/tsx/package.json +0 -68
  161. package/dist/node_modules/@struct-ai/sdk/node_modules/typescript/package.json +0 -120
  162. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/config.d.ts +0 -3
  163. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/coverage.d.ts +0 -1
  164. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/environments.d.ts +0 -1
  165. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/globals.d.ts +0 -22
  166. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/import-meta.d.ts +0 -5
  167. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/importMeta.d.ts +0 -4
  168. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/jsdom.d.ts +0 -6
  169. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/mocker.d.ts +0 -1
  170. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/node.d.ts +0 -1
  171. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/optional-runtime-types.d.ts +0 -6
  172. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/optional-types.d.ts +0 -7
  173. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/package.json +0 -239
  174. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/reporters.d.ts +0 -1
  175. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/runners.d.ts +0 -1
  176. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/snapshot.d.ts +0 -1
  177. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/suite.d.ts +0 -1
  178. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/worker.d.ts +0 -1
  179. package/dist/node_modules/@struct-ai/sdk/node_modules/zod/index.d.ts +0 -4
  180. package/dist/node_modules/@struct-ai/sdk/node_modules/zod/locales/package.json +0 -7
  181. package/dist/node_modules/@struct-ai/sdk/node_modules/zod/mini/package.json +0 -7
  182. package/dist/node_modules/@struct-ai/sdk/node_modules/zod/package.json +0 -135
  183. package/dist/node_modules/@struct-ai/sdk/node_modules/zod/v3/package.json +0 -7
  184. package/dist/node_modules/@struct-ai/sdk/node_modules/zod/v4/classic/package.json +0 -7
  185. package/dist/node_modules/@struct-ai/sdk/node_modules/zod/v4/core/package.json +0 -7
  186. package/dist/node_modules/@struct-ai/sdk/node_modules/zod/v4/locales/package.json +0 -7
  187. package/dist/node_modules/@struct-ai/sdk/node_modules/zod/v4/mini/package.json +0 -7
  188. package/dist/node_modules/@struct-ai/sdk/node_modules/zod/v4/package.json +0 -7
  189. package/dist/node_modules/@struct-ai/sdk/node_modules/zod/v4-mini/package.json +0 -7
  190. package/dist/node_modules/@struct-ai/sdk/package.json +0 -103
@@ -1,200 +0,0 @@
1
- declare module "path/posix" {
2
- import path = require("path");
3
- export = path;
4
- }
5
- declare module "path/win32" {
6
- import path = require("path");
7
- export = path;
8
- }
9
- /**
10
- * The `node:path` module provides utilities for working with file and directory
11
- * paths. It can be accessed using:
12
- *
13
- * ```js
14
- * import path from 'node:path';
15
- * ```
16
- * @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/path.js)
17
- */
18
- declare module "path" {
19
- namespace path {
20
- /**
21
- * A parsed path object generated by path.parse() or consumed by path.format().
22
- */
23
- interface ParsedPath {
24
- /**
25
- * The root of the path such as '/' or 'c:\'
26
- */
27
- root: string;
28
- /**
29
- * The full directory path such as '/home/user/dir' or 'c:\path\dir'
30
- */
31
- dir: string;
32
- /**
33
- * The file name including extension (if any) such as 'index.html'
34
- */
35
- base: string;
36
- /**
37
- * The file extension (if any) such as '.html'
38
- */
39
- ext: string;
40
- /**
41
- * The file name without extension (if any) such as 'index'
42
- */
43
- name: string;
44
- }
45
- interface FormatInputPathObject {
46
- /**
47
- * The root of the path such as '/' or 'c:\'
48
- */
49
- root?: string | undefined;
50
- /**
51
- * The full directory path such as '/home/user/dir' or 'c:\path\dir'
52
- */
53
- dir?: string | undefined;
54
- /**
55
- * The file name including extension (if any) such as 'index.html'
56
- */
57
- base?: string | undefined;
58
- /**
59
- * The file extension (if any) such as '.html'
60
- */
61
- ext?: string | undefined;
62
- /**
63
- * The file name without extension (if any) such as 'index'
64
- */
65
- name?: string | undefined;
66
- }
67
- interface PlatformPath {
68
- /**
69
- * Normalize a string path, reducing '..' and '.' parts.
70
- * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. If the path is a zero-length string, '.' is returned, representing the current working directory.
71
- *
72
- * @param path string path to normalize.
73
- * @throws {TypeError} if `path` is not a string.
74
- */
75
- normalize(path: string): string;
76
- /**
77
- * Join all arguments together and normalize the resulting path.
78
- *
79
- * @param paths paths to join.
80
- * @throws {TypeError} if any of the path segments is not a string.
81
- */
82
- join(...paths: string[]): string;
83
- /**
84
- * The right-most parameter is considered {to}. Other parameters are considered an array of {from}.
85
- *
86
- * Starting from leftmost {from} parameter, resolves {to} to an absolute path.
87
- *
88
- * If {to} isn't already absolute, {from} arguments are prepended in right to left order,
89
- * until an absolute path is found. If after using all {from} paths still no absolute path is found,
90
- * the current working directory is used as well. The resulting path is normalized,
91
- * and trailing slashes are removed unless the path gets resolved to the root directory.
92
- *
93
- * @param paths A sequence of paths or path segments.
94
- * @throws {TypeError} if any of the arguments is not a string.
95
- */
96
- resolve(...paths: string[]): string;
97
- /**
98
- * The `path.matchesGlob()` method determines if `path` matches the `pattern`.
99
- * @param path The path to glob-match against.
100
- * @param pattern The glob to check the path against.
101
- * @returns Whether or not the `path` matched the `pattern`.
102
- * @throws {TypeError} if `path` or `pattern` are not strings.
103
- * @since v20.17.0
104
- */
105
- matchesGlob(path: string, pattern: string): boolean;
106
- /**
107
- * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.
108
- *
109
- * If the given {path} is a zero-length string, `false` will be returned.
110
- *
111
- * @param path path to test.
112
- * @throws {TypeError} if `path` is not a string.
113
- */
114
- isAbsolute(path: string): boolean;
115
- /**
116
- * Solve the relative path from {from} to {to} based on the current working directory.
117
- * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve.
118
- *
119
- * @throws {TypeError} if either `from` or `to` is not a string.
120
- */
121
- relative(from: string, to: string): string;
122
- /**
123
- * Return the directory name of a path. Similar to the Unix dirname command.
124
- *
125
- * @param path the path to evaluate.
126
- * @throws {TypeError} if `path` is not a string.
127
- */
128
- dirname(path: string): string;
129
- /**
130
- * Return the last portion of a path. Similar to the Unix basename command.
131
- * Often used to extract the file name from a fully qualified path.
132
- *
133
- * @param path the path to evaluate.
134
- * @param suffix optionally, an extension to remove from the result.
135
- * @throws {TypeError} if `path` is not a string or if `ext` is given and is not a string.
136
- */
137
- basename(path: string, suffix?: string): string;
138
- /**
139
- * Return the extension of the path, from the last '.' to end of string in the last portion of the path.
140
- * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string.
141
- *
142
- * @param path the path to evaluate.
143
- * @throws {TypeError} if `path` is not a string.
144
- */
145
- extname(path: string): string;
146
- /**
147
- * The platform-specific file separator. '\\' or '/'.
148
- */
149
- readonly sep: "\\" | "/";
150
- /**
151
- * The platform-specific file delimiter. ';' or ':'.
152
- */
153
- readonly delimiter: ";" | ":";
154
- /**
155
- * Returns an object from a path string - the opposite of format().
156
- *
157
- * @param path path to evaluate.
158
- * @throws {TypeError} if `path` is not a string.
159
- */
160
- parse(path: string): ParsedPath;
161
- /**
162
- * Returns a path string from an object - the opposite of parse().
163
- *
164
- * @param pathObject path to evaluate.
165
- */
166
- format(pathObject: FormatInputPathObject): string;
167
- /**
168
- * On Windows systems only, returns an equivalent namespace-prefixed path for the given path.
169
- * If path is not a string, path will be returned without modifications.
170
- * This method is meaningful only on Windows system.
171
- * On POSIX systems, the method is non-operational and always returns path without modifications.
172
- */
173
- toNamespacedPath(path: string): string;
174
- /**
175
- * Posix specific pathing.
176
- * Same as parent object on posix.
177
- */
178
- readonly posix: PlatformPath;
179
- /**
180
- * Windows specific pathing.
181
- * Same as parent object on windows
182
- */
183
- readonly win32: PlatformPath;
184
- }
185
- }
186
- const path: path.PlatformPath;
187
- export = path;
188
- }
189
- declare module "node:path" {
190
- import path = require("path");
191
- export = path;
192
- }
193
- declare module "node:path/posix" {
194
- import path = require("path/posix");
195
- export = path;
196
- }
197
- declare module "node:path/win32" {
198
- import path = require("path/win32");
199
- export = path;
200
- }