sfml.js 1.0.0-rc.1 → 1.0.0

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 (334) hide show
  1. package/README.ja.md +177 -0
  2. package/README.ko.md +177 -0
  3. package/README.md +119 -14
  4. package/README.zh-CN.md +177 -0
  5. package/assets/branding/sfml-js-symbol-pentagon.svg +24 -0
  6. package/assets/branding/sfml-js-wordmark-dark.svg +20 -0
  7. package/assets/branding/sfml-js-wordmark.svg +19 -0
  8. package/assets/breakout.png +0 -0
  9. package/dist/audio/effect-processor.d.ts +53 -8
  10. package/dist/audio/effect-processor.js +35 -5
  11. package/dist/audio/input-sound-file.d.ts +101 -15
  12. package/dist/audio/input-sound-file.js +101 -15
  13. package/dist/audio/listener.d.ts +74 -12
  14. package/dist/audio/listener.js +74 -12
  15. package/dist/audio/music.d.ts +172 -22
  16. package/dist/audio/music.js +185 -24
  17. package/dist/audio/output-sound-file.d.ts +36 -4
  18. package/dist/audio/output-sound-file.js +36 -4
  19. package/dist/audio/playback-device.d.ts +103 -17
  20. package/dist/audio/playback-device.js +97 -16
  21. package/dist/audio/sound-buffer-recorder.d.ts +89 -9
  22. package/dist/audio/sound-buffer-recorder.js +89 -9
  23. package/dist/audio/sound-buffer.d.ts +121 -16
  24. package/dist/audio/sound-buffer.js +98 -13
  25. package/dist/audio/sound-file-factory.d.ts +84 -11
  26. package/dist/audio/sound-file-factory.js +84 -11
  27. package/dist/audio/sound-file-reader.d.ts +155 -24
  28. package/dist/audio/sound-file-reader.js +84 -13
  29. package/dist/audio/sound-file-writer.d.ts +49 -7
  30. package/dist/audio/sound-file-writer.js +13 -2
  31. package/dist/audio/sound-recorder.d.ts +143 -19
  32. package/dist/audio/sound-recorder.js +142 -18
  33. package/dist/audio/sound-source.d.ts +273 -45
  34. package/dist/audio/sound-source.js +273 -45
  35. package/dist/audio/sound-stream.d.ts +57 -9
  36. package/dist/audio/sound-stream.js +43 -7
  37. package/dist/audio/sound.d.ts +32 -5
  38. package/dist/audio/sound.js +32 -5
  39. package/dist/audio/value.d.ts +291 -48
  40. package/dist/audio/value.js +235 -39
  41. package/dist/audio/worker.d.ts +256 -38
  42. package/dist/graphics/blend-mode.d.ts +199 -33
  43. package/dist/graphics/blend-mode.js +163 -27
  44. package/dist/graphics/boolean-vector.d.ts +102 -16
  45. package/dist/graphics/boolean-vector.js +102 -16
  46. package/dist/graphics/circle-shape.d.ts +68 -11
  47. package/dist/graphics/circle-shape.js +37 -6
  48. package/dist/graphics/color.d.ts +227 -42
  49. package/dist/graphics/color.js +177 -32
  50. package/dist/graphics/convex-shape.d.ts +45 -7
  51. package/dist/graphics/convex-shape.js +31 -5
  52. package/dist/graphics/drawable.d.ts +15 -2
  53. package/dist/graphics/drawable.js +6 -1
  54. package/dist/graphics/font.d.ts +153 -24
  55. package/dist/graphics/font.js +116 -18
  56. package/dist/graphics/glsl-matrix.d.ts +44 -7
  57. package/dist/graphics/glsl-matrix.js +44 -7
  58. package/dist/graphics/glsl.d.ts +129 -21
  59. package/dist/graphics/glsl.js +123 -20
  60. package/dist/graphics/glyph.d.ts +106 -17
  61. package/dist/graphics/glyph.js +76 -12
  62. package/dist/graphics/image.d.ts +159 -24
  63. package/dist/graphics/image.js +122 -18
  64. package/dist/graphics/primitive-type.d.ts +42 -7
  65. package/dist/graphics/primitive-type.js +42 -7
  66. package/dist/graphics/rect.d.ts +162 -26
  67. package/dist/graphics/rect.js +101 -16
  68. package/dist/graphics/rectangle-shape.d.ts +44 -7
  69. package/dist/graphics/rectangle-shape.js +31 -5
  70. package/dist/graphics/render-states.d.ts +153 -25
  71. package/dist/graphics/render-states.js +49 -8
  72. package/dist/graphics/render-target.d.ts +145 -22
  73. package/dist/graphics/render-target.js +110 -17
  74. package/dist/graphics/render-texture.d.ts +100 -16
  75. package/dist/graphics/render-texture.js +80 -13
  76. package/dist/graphics/render-window.d.ts +106 -17
  77. package/dist/graphics/render-window.js +57 -9
  78. package/dist/graphics/shader.d.ts +153 -24
  79. package/dist/graphics/shader.js +126 -20
  80. package/dist/graphics/shape.d.ts +133 -21
  81. package/dist/graphics/shape.js +115 -18
  82. package/dist/graphics/sprite.d.ts +71 -11
  83. package/dist/graphics/sprite.js +57 -9
  84. package/dist/graphics/stencil-mode.d.ts +193 -32
  85. package/dist/graphics/stencil-mode.js +121 -20
  86. package/dist/graphics/swap.d.ts +13 -2
  87. package/dist/graphics/text.d.ts +624 -103
  88. package/dist/graphics/text.js +443 -73
  89. package/dist/graphics/texture.d.ts +209 -32
  90. package/dist/graphics/texture.js +137 -21
  91. package/dist/graphics/transform.d.ts +93 -14
  92. package/dist/graphics/transform.js +93 -14
  93. package/dist/graphics/transformable.d.ts +13 -2
  94. package/dist/graphics/transformable.js +13 -2
  95. package/dist/graphics/vertex-array.d.ts +83 -14
  96. package/dist/graphics/vertex-array.js +70 -12
  97. package/dist/graphics/vertex-buffer.d.ts +162 -26
  98. package/dist/graphics/vertex-buffer.js +106 -17
  99. package/dist/graphics/vertex.d.ts +83 -14
  100. package/dist/graphics/vertex.js +43 -7
  101. package/dist/graphics/view.d.ts +140 -22
  102. package/dist/graphics/view.js +103 -16
  103. package/dist/internal/glsl-value.d.ts +30 -5
  104. package/dist/internal/glsl-value.js +30 -5
  105. package/dist/internal/scalar.d.ts +9 -1
  106. package/dist/internal/transformable.d.ts +84 -13
  107. package/dist/internal/value-storage.d.ts +8 -1
  108. package/dist/network/common.d.ts +6 -1
  109. package/dist/network/common.js +6 -1
  110. package/dist/network/dns.d.ts +103 -14
  111. package/dist/network/dns.js +55 -6
  112. package/dist/network/ftp.d.ts +217 -33
  113. package/dist/network/ftp.js +217 -33
  114. package/dist/network/gen/constants.d.ts +750 -124
  115. package/dist/network/gen/constants.js +750 -124
  116. package/dist/network/http.d.ts +365 -57
  117. package/dist/network/http.js +365 -57
  118. package/dist/network/ip-address.d.ts +179 -26
  119. package/dist/network/ip-address.js +164 -24
  120. package/dist/network/packet.d.ts +200 -29
  121. package/dist/network/packet.js +101 -13
  122. package/dist/network/sftp.d.ts +525 -84
  123. package/dist/network/sftp.js +322 -53
  124. package/dist/network/socket-selector.d.ts +109 -15
  125. package/dist/network/socket-selector.js +103 -14
  126. package/dist/network/socket.d.ts +245 -33
  127. package/dist/network/socket.js +205 -28
  128. package/dist/network/tcp-listener.d.ts +91 -13
  129. package/dist/network/tcp-listener.js +85 -12
  130. package/dist/network/tcp-socket.d.ts +232 -33
  131. package/dist/network/tcp-socket.js +153 -22
  132. package/dist/network/tls-material.d.ts +18 -2
  133. package/dist/network/tls-material.js +18 -2
  134. package/dist/network/udp-socket.d.ts +137 -19
  135. package/dist/network/udp-socket.js +101 -13
  136. package/dist/system/angle.d.ts +60 -10
  137. package/dist/system/angle.js +60 -10
  138. package/dist/system/clock.d.ts +51 -8
  139. package/dist/system/clock.js +51 -8
  140. package/dist/system/err.d.ts +14 -2
  141. package/dist/system/err.js +14 -2
  142. package/dist/system/error.d.ts +12 -2
  143. package/dist/system/error.js +12 -2
  144. package/dist/system/file-input-stream.d.ts +54 -7
  145. package/dist/system/file-input-stream.js +54 -7
  146. package/dist/system/input-stream.d.ts +97 -13
  147. package/dist/system/input-stream.js +60 -8
  148. package/dist/system/operators.d.ts +146 -19
  149. package/dist/system/operators.js +118 -15
  150. package/dist/system/sleep.d.ts +6 -1
  151. package/dist/system/sleep.js +6 -1
  152. package/dist/system/suspend-aware-clock.d.ts +18 -3
  153. package/dist/system/suspend-aware-clock.js +18 -3
  154. package/dist/system/time.d.ts +81 -12
  155. package/dist/system/time.js +63 -9
  156. package/dist/system/timeout-with-predicate.d.ts +48 -7
  157. package/dist/system/timeout-with-predicate.js +20 -3
  158. package/dist/system/unicode.d.ts +42 -6
  159. package/dist/system/unicode.js +42 -6
  160. package/dist/system/vector2.d.ts +240 -36
  161. package/dist/system/vector2.js +105 -16
  162. package/dist/system/vector3.d.ts +197 -31
  163. package/dist/system/vector3.js +104 -16
  164. package/dist/system/version.d.ts +43 -7
  165. package/dist/system/version.js +7 -1
  166. package/dist/window/clipboard.d.ts +12 -2
  167. package/dist/window/clipboard.js +12 -2
  168. package/dist/window/context-settings.d.ts +78 -13
  169. package/dist/window/context-settings.js +30 -5
  170. package/dist/window/context.d.ts +70 -10
  171. package/dist/window/context.js +52 -7
  172. package/dist/window/cursor.d.ts +44 -6
  173. package/dist/window/cursor.js +28 -4
  174. package/dist/window/event.d.ts +423 -70
  175. package/dist/window/event.js +36 -6
  176. package/dist/window/gen/constants.d.ts +1890 -314
  177. package/dist/window/gen/constants.js +1890 -314
  178. package/dist/window/joystick.d.ts +67 -11
  179. package/dist/window/joystick.js +43 -7
  180. package/dist/window/keyboard.d.ts +42 -6
  181. package/dist/window/keyboard.js +26 -4
  182. package/dist/window/mouse.d.ts +24 -3
  183. package/dist/window/mouse.js +24 -3
  184. package/dist/window/sensor.d.ts +20 -3
  185. package/dist/window/sensor.js +20 -3
  186. package/dist/window/touch.d.ts +19 -4
  187. package/dist/window/touch.js +19 -4
  188. package/dist/window/video-mode.d.ts +61 -10
  189. package/dist/window/video-mode.js +36 -6
  190. package/dist/window/vulkan.d.ts +26 -3
  191. package/dist/window/vulkan.js +26 -3
  192. package/dist/window/window.d.ts +296 -44
  193. package/dist/window/window.js +241 -34
  194. package/docs/README.ja.md +30 -0
  195. package/docs/README.ko.md +30 -0
  196. package/docs/README.md +30 -0
  197. package/docs/README.zh-CN.md +30 -0
  198. package/docs/api.ja.md +84 -0
  199. package/docs/api.ko.md +84 -0
  200. package/docs/api.md +48 -1080
  201. package/docs/api.zh-CN.md +81 -0
  202. package/docs/audio.ja.md +249 -0
  203. package/docs/audio.ko.md +251 -0
  204. package/docs/audio.md +132 -92
  205. package/docs/audio.zh-CN.md +252 -0
  206. package/docs/concepts.ja.md +130 -0
  207. package/docs/concepts.ko.md +130 -0
  208. package/docs/concepts.md +131 -0
  209. package/docs/concepts.zh-CN.md +131 -0
  210. package/docs/development.ja.md +144 -0
  211. package/docs/development.ko.md +144 -0
  212. package/docs/development.md +112 -43
  213. package/docs/development.zh-CN.md +146 -0
  214. package/docs/getting-started.ja.md +154 -0
  215. package/docs/getting-started.ko.md +154 -0
  216. package/docs/getting-started.md +156 -0
  217. package/docs/getting-started.zh-CN.md +156 -0
  218. package/docs/graphics.ja.md +256 -0
  219. package/docs/graphics.ko.md +254 -0
  220. package/docs/graphics.md +255 -0
  221. package/docs/graphics.zh-CN.md +257 -0
  222. package/docs/network.ja.md +214 -0
  223. package/docs/network.ko.md +216 -0
  224. package/docs/network.md +133 -84
  225. package/docs/network.zh-CN.md +218 -0
  226. package/docs/system.ja.md +169 -0
  227. package/docs/system.ko.md +171 -0
  228. package/docs/system.md +173 -0
  229. package/docs/system.zh-CN.md +173 -0
  230. package/docs/window.ja.md +138 -0
  231. package/docs/window.ko.md +140 -0
  232. package/docs/window.md +141 -0
  233. package/docs/window.zh-CN.md +141 -0
  234. package/native/shared-handle.h +41 -3
  235. package/package.json +17 -6
  236. package/src/audio/effect-processor.ts +53 -8
  237. package/src/audio/input-sound-file.ts +101 -15
  238. package/src/audio/listener.ts +74 -12
  239. package/src/audio/music.ts +191 -25
  240. package/src/audio/output-sound-file.ts +36 -4
  241. package/src/audio/playback-device.ts +103 -17
  242. package/src/audio/sound-buffer-recorder.ts +89 -9
  243. package/src/audio/sound-buffer.ts +121 -16
  244. package/src/audio/sound-file-factory.ts +84 -11
  245. package/src/audio/sound-file-reader.ts +155 -24
  246. package/src/audio/sound-file-writer.ts +49 -7
  247. package/src/audio/sound-recorder.ts +155 -20
  248. package/src/audio/sound-source.ts +273 -45
  249. package/src/audio/sound-stream.ts +57 -9
  250. package/src/audio/sound.ts +32 -5
  251. package/src/audio/value.ts +291 -48
  252. package/src/audio/worker.ts +256 -38
  253. package/src/graphics/blend-mode.ts +199 -33
  254. package/src/graphics/boolean-vector.ts +102 -16
  255. package/src/graphics/circle-shape.ts +68 -11
  256. package/src/graphics/color.ts +227 -42
  257. package/src/graphics/convex-shape.ts +45 -7
  258. package/src/graphics/drawable.ts +15 -2
  259. package/src/graphics/font.ts +153 -24
  260. package/src/graphics/glsl-matrix.ts +44 -7
  261. package/src/graphics/glsl.ts +129 -21
  262. package/src/graphics/glyph.ts +106 -17
  263. package/src/graphics/image.ts +159 -24
  264. package/src/graphics/primitive-type.ts +42 -7
  265. package/src/graphics/rect.ts +162 -26
  266. package/src/graphics/rectangle-shape.ts +44 -7
  267. package/src/graphics/render-states.ts +153 -25
  268. package/src/graphics/render-target.ts +145 -22
  269. package/src/graphics/render-texture.ts +100 -16
  270. package/src/graphics/render-window.ts +113 -18
  271. package/src/graphics/shader.ts +153 -24
  272. package/src/graphics/shape.ts +133 -21
  273. package/src/graphics/sprite.ts +71 -11
  274. package/src/graphics/stencil-mode.ts +193 -32
  275. package/src/graphics/swap.ts +13 -2
  276. package/src/graphics/text.ts +624 -103
  277. package/src/graphics/texture.ts +209 -32
  278. package/src/graphics/transform.ts +93 -14
  279. package/src/graphics/transformable.ts +13 -2
  280. package/src/graphics/vertex-array.ts +83 -14
  281. package/src/graphics/vertex-buffer.ts +162 -26
  282. package/src/graphics/vertex.ts +83 -14
  283. package/src/graphics/view.ts +140 -22
  284. package/src/internal/glsl-value.ts +30 -5
  285. package/src/internal/scalar.ts +9 -1
  286. package/src/internal/transformable.ts +84 -13
  287. package/src/internal/value-storage.ts +8 -1
  288. package/src/network/common.ts +6 -1
  289. package/src/network/dns.ts +103 -14
  290. package/src/network/ftp.ts +217 -33
  291. package/src/network/gen/constants.ts +750 -124
  292. package/src/network/http.ts +365 -57
  293. package/src/network/ip-address.ts +179 -26
  294. package/src/network/packet.ts +200 -29
  295. package/src/network/sftp.ts +525 -84
  296. package/src/network/socket-selector.ts +109 -15
  297. package/src/network/socket.ts +245 -33
  298. package/src/network/tcp-listener.ts +91 -13
  299. package/src/network/tcp-socket.ts +232 -33
  300. package/src/network/tls-material.ts +18 -2
  301. package/src/network/udp-socket.ts +137 -19
  302. package/src/system/angle.ts +60 -10
  303. package/src/system/clock.ts +51 -8
  304. package/src/system/err.ts +14 -2
  305. package/src/system/error.ts +12 -2
  306. package/src/system/file-input-stream.ts +54 -7
  307. package/src/system/input-stream.ts +97 -13
  308. package/src/system/operators.ts +146 -19
  309. package/src/system/sleep.ts +6 -1
  310. package/src/system/suspend-aware-clock.ts +18 -3
  311. package/src/system/time.ts +81 -12
  312. package/src/system/timeout-with-predicate.ts +48 -7
  313. package/src/system/unicode.ts +42 -6
  314. package/src/system/vector2.ts +240 -36
  315. package/src/system/vector3.ts +197 -31
  316. package/src/system/version.ts +43 -7
  317. package/src/window/clipboard.ts +12 -2
  318. package/src/window/context-settings.ts +78 -13
  319. package/src/window/context.ts +70 -10
  320. package/src/window/cursor.ts +44 -6
  321. package/src/window/event.ts +423 -70
  322. package/src/window/gen/constants.ts +1890 -314
  323. package/src/window/joystick.ts +67 -11
  324. package/src/window/keyboard.ts +42 -6
  325. package/src/window/mouse.ts +24 -3
  326. package/src/window/sensor.ts +20 -3
  327. package/src/window/touch.ts +19 -4
  328. package/src/window/video-mode.ts +61 -10
  329. package/src/window/vulkan.ts +26 -3
  330. package/src/window/window.ts +314 -46
  331. package/tools/constant-docs.cjs +109 -0
  332. package/tools/constant-docs.json +1318 -0
  333. package/tools/generate-network-constants.cjs +21 -9
  334. package/tools/generate-window-constants.cjs +26 -12
@@ -3,141 +3,459 @@ import { TimeoutWithPredicate } from '../system/timeout-with-predicate';
3
3
  import { type NetworkTime } from './common';
4
4
  import { SftpResultValue as Value, SftpHostKeyType } from './gen/constants';
5
5
  export { SftpResultValue, SftpHostKeyType } from './gen/constants';
6
- /** 无进展超时配置;收到数据或 RPC 完成时重置计时,零时长不设超时。 */
6
+ /**
7
+ * No-progress timeout configuration; reset the timer when data arrives or
8
+ * an RPC completes. A zero duration disables the timeout.
9
+ * @zh 无进展超时配置;收到数据或 RPC 完成时重置计时,零时长不设超时。
10
+ * @ja 進捗がない場合のタイムアウト設定。データ受信または RPC 完了で
11
+ * タイマーをリセットします。期間がゼロならタイムアウトなしです。
12
+ * @ko 진행이 없을 때의 제한 시간 설정. 데이터 수신 또는 RPC 완료 시 타이머를
13
+ * 재설정하며 기간이 0이면 제한 시간이 없습니다.
14
+ */
7
15
  export type SftpTimeout = NetworkTime | TimeoutWithPredicate;
8
- /** SFTP 操作状态和消息。 */
16
+ /**
17
+ * SFTP operation status and message.
18
+ * @zh SFTP 操作状态和消息。
19
+ * @ja SFTP 操作の状態とメッセージ。
20
+ * @ko SFTP 작업 상태와 메시지.
21
+ */
9
22
  export declare class SftpResult {
10
23
  private readonly value;
11
24
  private readonly message;
12
- /** SFTP 结果码枚举。 */
25
+ /**
26
+ * SFTP result code enumeration.
27
+ * @zh SFTP 结果码枚举。
28
+ * @ja SFTP 結果コードの列挙型。
29
+ * @ko SFTP 결과 코드 열거형.
30
+ */
13
31
  static readonly Value: typeof Value;
14
- /** 从结果码及可选说明创建结果。 */
32
+ /**
33
+ * Create a result from a result code and optional description.
34
+ * @zh 从结果码及可选说明创建结果。
35
+ * @ja 結果コードと任意の説明から結果を作成します。
36
+ * @ko 결과 코드와 선택적 설명으로 결과를 생성합니다.
37
+ */
15
38
  constructor(value: Value, message?: string);
16
- /** 返回结果是否为 Success。 */
39
+ /**
40
+ * Return whether the result is Success.
41
+ * @zh 返回结果是否为 Success。
42
+ * @ja 結果が Success かどうかを返します。
43
+ * @ko 결과가 Success인지 반환합니다.
44
+ */
17
45
  isOk(): boolean;
18
- /** 返回结果码。 */
46
+ /**
47
+ * Return the result code.
48
+ * @zh 返回结果码。
49
+ * @ja 結果コードを返します。
50
+ * @ko 결과 코드를 반환합니다.
51
+ */
19
52
  getValue(): Value;
20
- /** 返回错误或状态说明。 */
53
+ /**
54
+ * Return the error or status description.
55
+ * @zh 返回错误或状态说明。
56
+ * @ja エラーまたは状態の説明を返します。
57
+ * @ko 오류 또는 상태 설명을 반환합니다.
58
+ */
21
59
  getMessage(): string;
22
60
  }
23
- /** 带远端路径的操作结果。 */
61
+ /**
62
+ * Operation result containing a remote path.
63
+ * @zh 带远端路径的操作结果。
64
+ * @ja リモートパスを含む操作結果。
65
+ * @ko 원격 경로를 포함하는 작업 결과.
66
+ */
24
67
  export declare class SftpPathResult extends SftpResult {
25
68
  private readonly path;
26
- /** 复制结果状态并附加路径。 */
69
+ /**
70
+ * Copy the result status and attach a path.
71
+ * @zh 复制结果状态并附加路径。
72
+ * @ja 結果の状態をコピーし、パスを付加します。
73
+ * @ko 결과 상태를 복사하고 경로를 첨부합니다.
74
+ */
27
75
  constructor(result: SftpResult, path?: string);
28
- /** 返回远端路径;失败结果通常为空字符串。 */
76
+ /**
77
+ * Return the remote path; failed results usually contain an empty string.
78
+ * @zh 返回远端路径;失败结果通常为空字符串。
79
+ * @ja リモートパスを返します。失敗結果では通常、空文字列です。
80
+ * @ko 원격 경로를 반환하며 실패한 결과에서는 보통 빈 문자열입니다.
81
+ */
29
82
  getPath(): string;
30
83
  }
31
- /** 远端文件系统条目类型。 */
84
+ /**
85
+ * Remote filesystem entry type.
86
+ * @zh 远端文件系统条目类型。
87
+ * @ja リモートファイルシステムのエントリー型。
88
+ * @ko 원격 파일 시스템 항목 타입.
89
+ */
32
90
  export declare enum FileType {
33
- /** 未设置类型。 */
91
+ /**
92
+ * No type set.
93
+ * @zh 未设置类型。
94
+ * @ja 型が未設定です。
95
+ * @ko 타입이 설정되지 않았습니다.
96
+ */
34
97
  None = 0,
35
- /** 条目不存在。 */
98
+ /**
99
+ * Entry does not exist.
100
+ * @zh 条目不存在。
101
+ * @ja エントリーが存在しません。
102
+ * @ko 항목이 없습니다.
103
+ */
36
104
  NotFound = 1,
37
- /** 普通文件。 */
105
+ /**
106
+ * Regular file.
107
+ * @zh 普通文件。
108
+ * @ja 通常ファイル。
109
+ * @ko 일반 파일.
110
+ */
38
111
  Regular = 2,
39
- /** 目录。 */
112
+ /**
113
+ * Directory.
114
+ * @zh 目录。
115
+ * @ja ディレクトリ。
116
+ * @ko 디렉터리.
117
+ */
40
118
  Directory = 3,
41
- /** 符号链接。 */
119
+ /**
120
+ * Symbolic link.
121
+ * @zh 符号链接。
122
+ * @ja シンボリックリンク。
123
+ * @ko 심볼릭 링크.
124
+ */
42
125
  Symlink = 4,
43
- /** 块设备。 */
126
+ /**
127
+ * Block device.
128
+ * @zh 块设备。
129
+ * @ja ブロックデバイス。
130
+ * @ko 블록 장치.
131
+ */
44
132
  Block = 5,
45
- /** 字符设备。 */
133
+ /**
134
+ * Character device.
135
+ * @zh 字符设备。
136
+ * @ja キャラクターデバイス。
137
+ * @ko 문자 장치.
138
+ */
46
139
  Character = 6,
47
- /** 命名管道。 */
140
+ /**
141
+ * Named pipe.
142
+ * @zh 命名管道。
143
+ * @ja 名前付きパイプ。
144
+ * @ko 이름 있는 파이프.
145
+ */
48
146
  Fifo = 7,
49
- /** 套接字。 */
147
+ /**
148
+ * Socket.
149
+ * @zh 套接字。
150
+ * @ja ソケット。
151
+ * @ko 소켓.
152
+ */
50
153
  Socket = 8,
51
- /** 未知类型。 */
154
+ /**
155
+ * Unknown type.
156
+ * @zh 未知类型。
157
+ * @ja 不明な型。
158
+ * @ko 알 수 없는 타입.
159
+ */
52
160
  Unknown = 9
53
161
  }
54
- /** 远端条目属性;服务端未提供的字段为 undefined。 */
162
+ /**
163
+ * Remote entry attributes; fields omitted by the server are undefined.
164
+ * @zh 远端条目属性;服务端未提供的字段为 undefined。
165
+ * @ja リモートエントリーの属性。サーバーが提供しないフィールドは undefined です。
166
+ * @ko 원격 항목 속성. 서버가 제공하지 않은 필드는 undefined입니다.
167
+ */
55
168
  export interface SftpAttributes {
56
- /** 查询路径;目录列表中为条目名称。 */
169
+ /**
170
+ * Queried path, or entry name in directory listings.
171
+ * @zh 查询路径;目录列表中为条目名称。
172
+ * @ja 照会したパス。ディレクトリ一覧ではエントリー名です。
173
+ * @ko 조회 경로. 디렉터리 목록에서는 항목 이름입니다.
174
+ */
57
175
  path: string;
58
- /** 文件系统条目类型。 */
176
+ /**
177
+ * Filesystem entry type.
178
+ * @zh 文件系统条目类型。
179
+ * @ja ファイルシステムのエントリー型。
180
+ * @ko 파일 시스템 항목 타입.
181
+ */
59
182
  type?: FileType;
60
- /** 文件大小,单位为字节。 */
183
+ /**
184
+ * File size in bytes.
185
+ * @zh 文件大小,单位为字节。
186
+ * @ja バイト単位のファイルサイズ。
187
+ * @ko 바이트 단위의 파일 크기.
188
+ */
61
189
  size?: bigint;
62
- /** Unix 权限位,范围 0~0o7777。 */
190
+ /**
191
+ * Unix permission bits, ranging from 0 to 0o7777.
192
+ * @zh Unix 权限位,范围 0~0o7777。
193
+ * @ja Unix 権限ビット。範囲は 0~0o7777 です。
194
+ * @ko Unix 권한 비트. 범위는 0~0o7777입니다.
195
+ */
63
196
  permissions?: number;
64
- /** 所有者用户 ID。 */
197
+ /**
198
+ * Owner user ID.
199
+ * @zh 所有者用户 ID。
200
+ * @ja 所有者のユーザー ID。
201
+ * @ko 소유자 사용자 ID.
202
+ */
65
203
  userId?: bigint;
66
- /** 所有者组 ID。 */
204
+ /**
205
+ * Owner group ID.
206
+ * @zh 所有者组 ID。
207
+ * @ja 所有者のグループ ID。
208
+ * @ko 소유자 그룹 ID.
209
+ */
67
210
  groupId?: bigint;
68
- /** 最近访问时间。 */
211
+ /**
212
+ * Last access time.
213
+ * @zh 最近访问时间。
214
+ * @ja 最終アクセス時刻。
215
+ * @ko 마지막 접근 시간.
216
+ */
69
217
  accessTime?: Date;
70
- /** 最近修改时间。 */
218
+ /**
219
+ * Last modification time.
220
+ * @zh 最近修改时间。
221
+ * @ja 最終更新時刻。
222
+ * @ko 마지막 수정 시간.
223
+ */
71
224
  modificationTime?: Date;
72
225
  }
73
- /** 带单个文件系统条目属性的结果。 */
226
+ /**
227
+ * Result containing attributes of one filesystem entry.
228
+ * @zh 带单个文件系统条目属性的结果。
229
+ * @ja 単一ファイルシステムエントリーの属性を含む結果。
230
+ * @ko 파일 시스템 항목 하나의 속성을 포함하는 결과.
231
+ */
74
232
  export declare class SftpAttributesResult extends SftpResult {
75
233
  private readonly attributes;
76
- /** 复制结果状态并附加属性对象。 */
234
+ /**
235
+ * Copy the result status and attach an attributes object.
236
+ * @zh 复制结果状态并附加属性对象。
237
+ * @ja 結果の状態をコピーし、属性オブジェクトを付加します。
238
+ * @ko 결과 상태를 복사하고 속성 객체를 첨부합니다.
239
+ */
77
240
  constructor(result: SftpResult, attributes?: SftpAttributes);
78
- /** 返回此结果持有的属性对象。 */
241
+ /**
242
+ * Return the attributes object held by this result.
243
+ * @zh 返回此结果持有的属性对象。
244
+ * @ja この結果が保持する属性オブジェクトを返します。
245
+ * @ko 이 결과가 보유한 속성 객체를 반환합니다.
246
+ */
79
247
  getAttributes(): SftpAttributes;
80
248
  }
81
- /** 带目录条目属性列表的结果。 */
249
+ /**
250
+ * Result containing a list of directory entry attributes.
251
+ * @zh 带目录条目属性列表的结果。
252
+ * @ja ディレクトリエントリーの属性一覧を含む結果。
253
+ * @ko 디렉터리 항목 속성 목록을 포함하는 결과.
254
+ */
82
255
  export declare class SftpListingResult extends SftpResult {
83
256
  private readonly listing;
84
- /** 复制结果状态并附加条目列表。 */
257
+ /**
258
+ * Copy the result status and attach an entry list.
259
+ * @zh 复制结果状态并附加条目列表。
260
+ * @ja 結果の状態をコピーし、エントリー一覧を付加します。
261
+ * @ko 결과 상태를 복사하고 항목 목록을 첨부합니다.
262
+ */
85
263
  constructor(result: SftpResult, listing?: SftpAttributes[]);
86
- /** 返回此结果持有的目录条目列表。 */
264
+ /**
265
+ * Return the directory entry list held by this result.
266
+ * @zh 返回此结果持有的目录条目列表。
267
+ * @ja この結果が保持するディレクトリエントリー一覧を返します。
268
+ * @ko 이 결과가 보유한 디렉터리 항목 목록을 반환합니다.
269
+ */
87
270
  getListing(): readonly SftpAttributes[];
88
271
  }
89
- /** SSH 握手协商结果,供应用核验主机公钥和算法。 */
272
+ /**
273
+ * SSH handshake negotiation results for application verification
274
+ * of the host public key and algorithms.
275
+ * @zh SSH 握手协商结果,供应用核验主机公钥和算法。
276
+ * @ja アプリケーションによるホスト公開鍵とアルゴリズムの検証に使う
277
+ * SSH ハンドシェイクの交渉結果。
278
+ * @ko 애플리케이션이 호스트 공개 키와 알고리즘을 검증하는 데 사용하는
279
+ * SSH 핸드셰이크 협상 결과.
280
+ */
90
281
  export interface SftpSessionInfo {
91
- /** 服务端主机公钥与原始指纹字节。 */
282
+ /**
283
+ * Server host public key and raw fingerprint bytes.
284
+ * @zh 服务端主机公钥与原始指纹字节。
285
+ * @ja サーバーホストの公開鍵とフィンガープリントの生バイト。
286
+ * @ko 서버 호스트 공개 키와 원시 지문 바이트.
287
+ */
92
288
  hostKey: {
93
- /** 公钥类型。 */
289
+ /**
290
+ * Public key type.
291
+ * @zh 公钥类型。
292
+ * @ja 公開鍵の型。
293
+ * @ko 공개 키 타입.
294
+ */
94
295
  type: SftpHostKeyType;
95
- /** SSH 编码的公钥数据副本。 */
296
+ /**
297
+ * Copy of SSH-encoded public key data.
298
+ * @zh SSH 编码的公钥数据副本。
299
+ * @ja SSH 符号化された公開鍵データのコピー。
300
+ * @ko SSH로 인코딩된 공개 키 데이터 복사본.
301
+ */
96
302
  data: Uint8Array;
97
- /** SHA-1 指纹原始字节。 */
303
+ /**
304
+ * Raw SHA-1 fingerprint bytes.
305
+ * @zh SHA-1 指纹原始字节。
306
+ * @ja SHA-1 フィンガープリントの生バイト。
307
+ * @ko SHA-1 지문 원시 바이트.
308
+ */
98
309
  sha1: Uint8Array;
99
- /** SHA-256 指纹原始字节。 */
310
+ /**
311
+ * Raw SHA-256 fingerprint bytes.
312
+ * @zh SHA-256 指纹原始字节。
313
+ * @ja SHA-256 フィンガープリントの生バイト。
314
+ * @ko SHA-256 지문 원시 바이트.
315
+ */
100
316
  sha256: Uint8Array;
101
317
  };
102
- /** 密钥交换算法。 */
318
+ /**
319
+ * Key exchange algorithm.
320
+ * @zh 密钥交换算法。
321
+ * @ja 鍵交換アルゴリズム。
322
+ * @ko 키 교환 알고리즘.
323
+ */
103
324
  keyExchangeAlgorithm: string;
104
- /** 服务端主机公钥算法。 */
325
+ /**
326
+ * Server host public key algorithm.
327
+ * @zh 服务端主机公钥算法。
328
+ * @ja サーバーホストの公開鍵アルゴリズム。
329
+ * @ko 서버 호스트 공개 키 알고리즘.
330
+ */
105
331
  hostKeyAlgorithm: string;
106
- /** 客户端到服务端的加密算法。 */
332
+ /**
333
+ * Client-to-server encryption algorithm.
334
+ * @zh 客户端到服务端的加密算法。
335
+ * @ja クライアントからサーバーへの暗号化アルゴリズム。
336
+ * @ko 클라이언트에서 서버로의 암호화 알고리즘.
337
+ */
107
338
  clientToServerEncryptionAlgorithm: string;
108
- /** 服务端到客户端的加密算法。 */
339
+ /**
340
+ * Server-to-client encryption algorithm.
341
+ * @zh 服务端到客户端的加密算法。
342
+ * @ja サーバーからクライアントへの暗号化アルゴリズム。
343
+ * @ko 서버에서 클라이언트로의 암호화 알고리즘.
344
+ */
109
345
  serverToClientEncryptionAlgorithm: string;
110
- /** 客户端到服务端的消息认证算法。 */
346
+ /**
347
+ * Client-to-server message authentication algorithm.
348
+ * @zh 客户端到服务端的消息认证算法。
349
+ * @ja クライアントからサーバーへのメッセージ認証アルゴリズム。
350
+ * @ko 클라이언트에서 서버로의 메시지 인증 알고리즘.
351
+ */
111
352
  clientToServerMacAlgorithm: string;
112
- /** 服务端到客户端的消息认证算法。 */
353
+ /**
354
+ * Server-to-client message authentication algorithm.
355
+ * @zh 服务端到客户端的消息认证算法。
356
+ * @ja サーバーからクライアントへのメッセージ認証アルゴリズム。
357
+ * @ko 서버에서 클라이언트로의 메시지 인증 알고리즘.
358
+ */
113
359
  serverToClientMacAlgorithm: string;
114
- /** 客户端到服务端的压缩算法。 */
360
+ /**
361
+ * Client-to-server compression algorithm.
362
+ * @zh 客户端到服务端的压缩算法。
363
+ * @ja クライアントからサーバーへの圧縮アルゴリズム。
364
+ * @ko 클라이언트에서 서버로의 압축 알고리즘.
365
+ */
115
366
  clientToServerCompressionAlgorithm: string;
116
- /** 服务端到客户端的压缩算法。 */
367
+ /**
368
+ * Server-to-client compression algorithm.
369
+ * @zh 服务端到客户端的压缩算法。
370
+ * @ja サーバーからクライアントへの圧縮アルゴリズム。
371
+ * @ko 서버에서 클라이언트로의 압축 알고리즘.
372
+ */
117
373
  serverToClientCompressionAlgorithm: string;
118
374
  }
119
- /** 消费下载块,返回 false 提前结束;空块表示文件末尾。 */
375
+ /**
376
+ * Consume a download chunk; return false to stop early.
377
+ * An empty chunk indicates end of file.
378
+ * @zh 消费下载块,返回 false 提前结束;空块表示文件末尾。
379
+ * @ja ダウンロードチャンクを処理し、false を返すと早期終了します。
380
+ * 空チャンクはファイル終端を示します。
381
+ * @ko 다운로드 청크를 처리하며 false를 반환하면 조기 종료합니다.
382
+ * 빈 청크는 파일 끝을 나타냅니다.
383
+ */
120
384
  export type SftpDownloadCallback = (data: Uint8Array) => boolean | Promise<boolean>;
121
- /** 上传回调接收的可填充数据块。 */
385
+ /**
386
+ * Writable data chunk received by an upload callback.
387
+ * @zh 上传回调接收的可填充数据块。
388
+ * @ja アップロードコールバックが受け取る書き込み可能なデータチャンク。
389
+ * @ko 업로드 콜백이 받는 채울 수 있는 데이터 청크.
390
+ */
122
391
  export interface SftpUploadChunk {
123
- /** 本次写入区,需填充原缓冲区,不得替换引用。 */
392
+ /**
393
+ * Current write area; fill the original buffer without replacing
394
+ * its reference.
395
+ * @zh 本次写入区,需填充原缓冲区,不得替换引用。
396
+ * @ja 今回の書き込み領域。参照を置換せず、元のバッファを埋めてください。
397
+ * @ko 이번 쓰기 영역. 참조를 교체하지 말고 원래 버퍼를 채워야 합니다.
398
+ */
124
399
  readonly data: Uint8Array;
125
- /** 实际写入字节数,不得超过 data.length。 */
400
+ /**
401
+ * Actual byte count written; must not exceed data.length.
402
+ * @zh 实际写入字节数,不得超过 data.length。
403
+ * @ja 実際に書き込んだバイト数。data.length を超えてはなりません。
404
+ * @ko 실제로 쓴 바이트 수. data.length를 초과하면 안 됩니다.
405
+ */
126
406
  size: number;
127
407
  }
128
- /** 填充上传块并设置 size;返回 false 时仍发送当前块,然后结束。 */
408
+ /**
409
+ * Fill an upload chunk and set size; returning false still sends
410
+ * the current chunk before stopping.
411
+ * @zh 填充上传块并设置 size;返回 false 时仍发送当前块,然后结束。
412
+ * @ja アップロードチャンクを埋めて size を設定します。
413
+ * false を返しても現在のチャンクを送信してから終了します。
414
+ * @ko 업로드 청크를 채우고 size를 설정합니다.
415
+ * false를 반환해도 현재 청크를 보낸 후 종료합니다.
416
+ */
129
417
  export type SftpUploadCallback = (chunk: SftpUploadChunk) => boolean | Promise<boolean>;
130
- /** 基于 ssh2 的异步 SFTP 客户端,文件操作按调用顺序执行。 */
418
+ /**
419
+ * Asynchronous SFTP client based on ssh2; file operations run in call order.
420
+ * @zh 基于 ssh2 的异步 SFTP 客户端,文件操作按调用顺序执行。
421
+ * @ja ssh2 ベースの非同期 SFTP クライアント。ファイル操作は呼び出し順に実行します。
422
+ * @ko ssh2 기반 비동기 SFTP 클라이언트. 파일 작업은 호출 순서대로 실행됩니다.
423
+ */
131
424
  export declare class Sftp {
132
- /** 基本结果类型。 */
425
+ /**
426
+ * Basic result type.
427
+ * @zh 基本结果类型。
428
+ * @ja 基本結果型。
429
+ * @ko 기본 결과 타입.
430
+ */
133
431
  static readonly Result: typeof SftpResult;
134
- /** 路径结果类型。 */
432
+ /**
433
+ * Path result type.
434
+ * @zh 路径结果类型。
435
+ * @ja パス結果型。
436
+ * @ko 경로 결과 타입.
437
+ */
135
438
  static readonly PathResult: typeof SftpPathResult;
136
- /** 属性结果类型。 */
439
+ /**
440
+ * Attributes result type.
441
+ * @zh 属性结果类型。
442
+ * @ja 属性結果型。
443
+ * @ko 속성 결과 타입.
444
+ */
137
445
  static readonly AttributesResult: typeof SftpAttributesResult;
138
- /** 目录列表结果类型。 */
446
+ /**
447
+ * Directory listing result type.
448
+ * @zh 目录列表结果类型。
449
+ * @ja ディレクトリ一覧結果型。
450
+ * @ko 디렉터리 목록 결과 타입.
451
+ */
139
452
  static readonly ListingResult: typeof SftpListingResult;
140
- /** 服务端主机公钥类型。 */
453
+ /**
454
+ * Server host public key type.
455
+ * @zh 服务端主机公钥类型。
456
+ * @ja サーバーホストの公開鍵型。
457
+ * @ko 서버 호스트 공개 키 타입.
458
+ */
141
459
  static readonly HostKeyType: typeof SftpHostKeyType;
142
460
  /** SSH 连接客户端实例。 */
143
461
  private client?;
@@ -164,47 +482,170 @@ export declare class Sftp {
164
482
  /** 接收数据或完成 RPC 时的进度回调,用于超时重置。 */
165
483
  private progress;
166
484
  /**
167
- * 建立 SSH 握手,默认端口 22;随后调用 login 完成身份认证。
485
+ * Establish an SSH handshake on port 22 by default; then call login
486
+ * to authenticate. Host trust is not verified automatically; applications
487
+ * can verify the host fingerprint via getSessionInfo before logging in.
488
+ * @zh 建立 SSH 握手,默认端口 22;随后调用 login 完成身份认证。
168
489
  * 不自动核验主机可信性,应用可在登录前通过 getSessionInfo 核验主机指纹。
490
+ * @ja SSH ハンドシェイクを確立します。既定のポートは 22 で、
491
+ * その後 login で認証します。ホストの信頼性は自動検証しません。
492
+ * アプリケーションはログイン前に getSessionInfo で指紋を検証できます。
493
+ * @ko SSH 핸드셰이크를 수행하며 기본 포트는 22입니다. 이후 login으로 인증합니다.
494
+ * 호스트 신뢰성은 자동으로 검증하지 않습니다. 애플리케이션은 로그인 전에
495
+ * getSessionInfo로 호스트 지문을 검증할 수 있습니다.
169
496
  */
170
497
  connect(server: IpAddress, port?: number, timeout?: SftpTimeout): Promise<SftpResult>;
171
- /** 立即关闭会话并返回成功结果;timeout 仅作参数校验。 */
498
+ /**
499
+ * Close the session immediately and return success;
500
+ * timeout is used only for argument validation.
501
+ * @zh 立即关闭会话并返回成功结果;timeout 仅作参数校验。
502
+ * @ja セッションを即座に閉じて成功結果を返します。
503
+ * timeout は引数の検証にのみ使用します。
504
+ * @ko 즉시 세션을 닫고 성공 결과를 반환합니다.
505
+ * timeout은 인수 검증에만 사용합니다.
506
+ */
172
507
  disconnect(timeout?: SftpTimeout): Promise<SftpResult>;
173
- /** 立即销毁 SSH 连接并唤醒待完成操作。 */
508
+ /**
509
+ * Destroy the SSH connection immediately and wake pending operations.
510
+ * @zh 立即销毁 SSH 连接并唤醒待完成操作。
511
+ * @ja SSH 接続を即座に破棄し、未完了の操作を起こします。
512
+ * @ko 즉시 SSH 연결을 해제하고 대기 중인 작업을 깨웁니다.
513
+ */
174
514
  close(): void;
175
- /** 以用户名和密码异步认证并打开 SFTP 通道。 */
515
+ /**
516
+ * Authenticate asynchronously with a username and password,
517
+ * then open an SFTP channel.
518
+ * @zh 以用户名和密码异步认证并打开 SFTP 通道。
519
+ * @ja ユーザー名とパスワードで非同期に認証し、SFTP チャネルを開きます。
520
+ * @ko 사용자 이름과 암호로 비동기 인증하고 SFTP 채널을 엽니다.
521
+ */
176
522
  login(name: string, password: string, timeout?: SftpTimeout): Promise<SftpResult>;
177
- /** 以匹配的公私钥及可选私钥密码异步认证,密钥参数为内容而非文件路径。 */
523
+ /**
524
+ * Authenticate asynchronously with matching public/private keys and an
525
+ * optional private-key passphrase; key arguments are contents, not paths.
526
+ * @zh 以匹配的公私钥及可选私钥密码异步认证,密钥参数为内容而非文件路径。
527
+ * @ja 対応する公開鍵・秘密鍵と任意の秘密鍵パスフレーズで非同期に認証します。
528
+ * 鍵の引数はファイルパスではなく内容です。
529
+ * @ko 일치하는 공개 키와 개인 키 및 선택적 개인 키 암호로 비동기 인증합니다.
530
+ * 키 인수는 파일 경로가 아닌 내용입니다.
531
+ */
178
532
  login(name: string, publicKey: string | Uint8Array, privateKey: string | Uint8Array, passphrase?: string, timeout?: SftpTimeout): Promise<SftpResult>;
179
- /** 返回主机公钥和协商算法的快照;握手信息未就绪时为 undefined。 */
533
+ /**
534
+ * Return a snapshot of the host public key and negotiated algorithms,
535
+ * or undefined if handshake information is not ready.
536
+ * @zh 返回主机公钥和协商算法的快照;握手信息未就绪时为 undefined。
537
+ * @ja ホスト公開鍵と合意したアルゴリズムのスナップショットを返します。
538
+ * ハンドシェイク情報が未準備なら undefined です。
539
+ * @ko 호스트 공개 키와 협상한 알고리즘의 스냅샷을 반환하며,
540
+ * 핸드셰이크 정보가 준비되지 않았으면 undefined입니다.
541
+ */
180
542
  getSessionInfo(): SftpSessionInfo | undefined;
181
- /** 请求服务器解析规范化绝对路径。 */
543
+ /**
544
+ * Ask the server to resolve a canonical absolute path.
545
+ * @zh 请求服务器解析规范化绝对路径。
546
+ * @ja 正規化された絶対パスの解決をサーバーに要求します。
547
+ * @ko 서버에 정규화된 절대 경로 확인을 요청합니다.
548
+ */
182
549
  resolvePath(path: string, timeout?: SftpTimeout): Promise<SftpPathResult>;
183
- /** 查询服务器对当前会话的默认工作目录。 */
550
+ /**
551
+ * Query the server's default working directory for the current session.
552
+ * @zh 查询服务器对当前会话的默认工作目录。
553
+ * @ja 現在のセッションに対するサーバーの既定作業ディレクトリを照会します。
554
+ * @ko 현재 세션에 대한 서버의 기본 작업 디렉터리를 조회합니다.
555
+ */
184
556
  getWorkingDirectory(timeout?: SftpTimeout): Promise<SftpPathResult>;
185
- /** 查询远端属性;followLinks 默认跟随符号链接,false 查询链接自身。 */
557
+ /**
558
+ * Query remote attributes; followLinks follows symbolic links by default,
559
+ * while false queries the link itself.
560
+ * @zh 查询远端属性;followLinks 默认跟随符号链接,false 查询链接自身。
561
+ * @ja リモート属性を照会します。followLinks は既定でシンボリックリンクを
562
+ * たどり、false ならリンク自体を照会します。
563
+ * @ko 원격 속성을 조회합니다. followLinks는 기본적으로 심볼릭 링크를 따르며,
564
+ * false이면 링크 자체를 조회합니다.
565
+ */
186
566
  getAttributes(path: string, followLinks?: boolean, timeout?: SftpTimeout): Promise<SftpAttributesResult>;
187
- /** 异步读取目录条目及其属性。 */
567
+ /**
568
+ * Read directory entries and their attributes asynchronously.
569
+ * @zh 异步读取目录条目及其属性。
570
+ * @ja ディレクトリエントリーとその属性を非同期に読み取ります。
571
+ * @ko 디렉터리 항목과 속성을 비동기로 읽습니다.
572
+ */
188
573
  getDirectoryListing(path: string, timeout?: SftpTimeout): Promise<SftpListingResult>;
189
- /** 创建远端目录,默认 Unix 权限为 0o755。 */
574
+ /**
575
+ * Create a remote directory with default Unix permissions of 0o755.
576
+ * @zh 创建远端目录,默认 Unix 权限为 0o755。
577
+ * @ja リモートディレクトリを作成します。既定の Unix 権限は 0o755 です。
578
+ * @ko 원격 디렉터리를 생성하며 기본 Unix 권한은 0o755입니다.
579
+ */
190
580
  createDirectory(path: string, permissions?: number, timeout?: SftpTimeout): Promise<SftpResult>;
191
- /** 删除远端空目录。 */
581
+ /**
582
+ * Delete an empty remote directory.
583
+ * @zh 删除远端空目录。
584
+ * @ja 空のリモートディレクトリを削除します。
585
+ * @ko 비어 있는 원격 디렉터리를 삭제합니다.
586
+ */
192
587
  deleteDirectory(path: string, timeout?: SftpTimeout): Promise<SftpResult>;
193
- /** 重命名远端路径;overwrite 为 true 时要求服务端支持 OpenSSH 覆盖重命名扩展。 */
588
+ /**
589
+ * Rename a remote path; overwrite true requires server support for
590
+ * the OpenSSH overwrite-rename extension.
591
+ * @zh 重命名远端路径;overwrite 为 true 时要求服务端支持 OpenSSH 覆盖重命名扩展。
592
+ * @ja リモートパスを改名します。overwrite が true の場合は
593
+ * OpenSSH の上書き改名拡張へのサーバー対応が必要です。
594
+ * @ko 원격 경로 이름을 변경합니다. overwrite가 true이면 서버가
595
+ * OpenSSH 덮어쓰기 이름 변경 확장을 지원해야 합니다.
596
+ */
194
597
  rename(oldPath: string, newPath: string, overwrite?: boolean, timeout?: SftpTimeout): Promise<SftpResult>;
195
- /** 删除远端文件或符号链接。 */
598
+ /**
599
+ * Delete a remote file or symbolic link.
600
+ * @zh 删除远端文件或符号链接。
601
+ * @ja リモートファイルまたはシンボリックリンクを削除します。
602
+ * @ko 원격 파일 또는 심볼릭 링크를 삭제합니다.
603
+ */
196
604
  deleteFile(path: string, timeout?: SftpTimeout): Promise<SftpResult>;
197
- /** 从字节偏移 offset 开始分块下载;依次等待 callback,偏移最大为 2^53−1。 */
605
+ /**
606
+ * Download chunks from byte offset offset, awaiting callback sequentially;
607
+ * the maximum offset is 2^53-1.
608
+ * @zh 从字节偏移 offset 开始分块下载;依次等待 callback,偏移最大为 2^53−1。
609
+ * @ja バイト位置 offset からチャンク単位でダウンロードし、callback を順に
610
+ * 待機します。オフセットの最大値は 2^53-1 です。
611
+ * @ko 바이트 오프셋 offset부터 청크 단위로 다운로드하며 callback을
612
+ * 순서대로 기다립니다. 최대 오프셋은 2^53-1입니다.
613
+ */
198
614
  download(path: string, callback: SftpDownloadCallback, offset?: bigint, timeout?: SftpTimeout): Promise<SftpResult>;
199
615
  /**
200
- * 按回调提供的数据块上传文件,逐块等待写入完成。
201
- * @param path 远端文件路径。
202
- * @param callback 填充缓冲区和 size 的回调。
203
- * @param permissions 新建文件权限,默认 0o644。
204
- * @param truncate 是否清空现有文件,默认 true。
205
- * @param append 是否要求追加写入,默认 false。
206
- * @param offset 起始字节偏移,默认 0n,最大 2^53−1。
207
- * @param timeout 无进展超时配置,默认不限时。
616
+ * Upload a file using callback-provided chunks, awaiting each chunk's write.
617
+ * @zh 按回调提供的数据块上传文件,逐块等待写入完成。
618
+ * @ja コールバックが提供するチャンクでファイルをアップロードし、
619
+ * 各チャンクの書き込み完了を待ちます。
620
+ * @ko 콜백이 제공하는 청크로 파일을 업로드하며 각 청크의 쓰기 완료를 기다립니다.
621
+ * @param path - Remote file path.
622
+ * @zh path - 远端文件路径。
623
+ * @ja path - リモートファイルのパス。
624
+ * @ko path - 원격 파일 경로.
625
+ * @param callback - Callback that fills the buffer and sets size.
626
+ * @zh callback - 填充缓冲区和 size 的回调。
627
+ * @ja callback - バッファを埋めて size を設定するコールバック。
628
+ * @ko callback - 버퍼를 채우고 size를 설정하는 콜백.
629
+ * @param permissions - Permissions for new files; defaults to 0o644.
630
+ * @zh permissions - 新建文件权限,默认 0o644。
631
+ * @ja permissions - 新規ファイルの権限。既定は 0o644 です。
632
+ * @ko permissions - 새 파일 권한. 기본값은 0o644입니다.
633
+ * @param truncate - Whether to clear an existing file; defaults to true.
634
+ * @zh truncate - 是否清空现有文件,默认 true。
635
+ * @ja truncate - 既存ファイルを空にするか。既定は true です。
636
+ * @ko truncate - 기존 파일을 비울지 여부. 기본값은 true입니다.
637
+ * @param append - Whether to request append writes; defaults to false.
638
+ * @zh append - 是否要求追加写入,默认 false。
639
+ * @ja append - 追記書き込みを要求するか。既定は false です。
640
+ * @ko append - 추가 쓰기를 요청할지 여부. 기본값은 false입니다.
641
+ * @param offset - Starting byte offset; defaults to 0n, maximum 2^53-1.
642
+ * @zh offset - 起始字节偏移,默认 0n,最大 2^53−1。
643
+ * @ja offset - 開始バイトオフセット。既定は 0n、最大値は 2^53-1 です。
644
+ * @ko offset - 시작 바이트 오프셋. 기본값은 0n, 최대값은 2^53-1입니다.
645
+ * @param timeout - No-progress timeout configuration; no timeout by default.
646
+ * @zh timeout - 无进展超时配置,默认不限时。
647
+ * @ja timeout - 進捗がない場合のタイムアウト設定。既定では制限なしです。
648
+ * @ko timeout - 진행이 없을 때의 제한 시간 설정. 기본적으로 제한이 없습니다.
208
649
  */
209
650
  upload(path: string, callback: SftpUploadCallback, permissions?: number, truncate?: boolean, append?: boolean, offset?: bigint, timeout?: SftpTimeout): Promise<SftpResult>;
210
651
  /** 将队列操作包装为标准 SftpResult 结果。 */