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
@@ -5,22 +5,65 @@ import { IpAddress } from './ip-address';
5
5
  import { Packet, packetReceive, packetSend } from './packet';
6
6
  import { SerialQueue, bytes, uint, waitFor } from './common';
7
7
 
8
- /** 单个 UDP 数据报的接收结果。 */
8
+ /**
9
+ * Result of receiving a single UDP datagram.
10
+ * @zh 单个 UDP 数据报的接收结果。
11
+ * @ja 単一の UDP データグラムの受信結果。
12
+ * @ko 단일 UDP 데이터그램 수신 결과.
13
+ */
9
14
  export interface DatagramResult {
10
- /** 操作结果状态。 */
15
+ /**
16
+ * Operation result status.
17
+ * @zh 操作结果状态。
18
+ * @ja 操作結果の状態。
19
+ * @ko 작업 결과 상태.
20
+ */
11
21
  status: Status;
12
- /** 写入目标的字节数,失败时为 0。 */
22
+ /**
23
+ * Bytes written to the destination, or 0 on failure.
24
+ * @zh 写入目标的字节数,失败时为 0。
25
+ * @ja 出力先に書き込んだバイト数。失敗時は 0 です。
26
+ * @ko 대상에 쓴 바이트 수이며 실패 시 0입니다.
27
+ */
13
28
  received: number;
14
- /** 成功接收时的发送方地址。 */
29
+ /**
30
+ * Sender address on successful receipt.
31
+ * @zh 成功接收时的发送方地址。
32
+ * @ja 受信成功時の送信元アドレス。
33
+ * @ko 수신 성공 시 송신자 주소.
34
+ */
15
35
  remoteAddress?: IpAddress;
16
- /** 发送方端口,失败时为 0。 */
36
+ /**
37
+ * Sender port, or 0 on failure.
38
+ * @zh 发送方端口,失败时为 0。
39
+ * @ja 送信元ポート。失敗時は 0 です。
40
+ * @ko 송신자 포트이며 실패 시 0입니다.
41
+ */
17
42
  remotePort: number;
18
43
  }
19
- /** 保留数据报边界的 UDP 套接字,Packet 不附加 TCP 长度头。 */
44
+ /**
45
+ * UDP socket preserving datagram boundaries; Packet data has no TCP
46
+ * length header.
47
+ * @zh 保留数据报边界的 UDP 套接字,Packet 不附加 TCP 长度头。
48
+ * @ja データグラム境界を保持する UDP ソケット。
49
+ * Packet に TCP の長さヘッダーは付加しません。
50
+ * @ko 데이터그램 경계를 유지하는 UDP 소켓.
51
+ * Packet에 TCP 길이 헤더를 붙이지 않습니다.
52
+ */
20
53
  export class UdpSocket extends Socket {
21
- /** 本实现允许的最大 UDP 数据报载荷字节数。 */
54
+ /**
55
+ * Maximum UDP datagram payload size in bytes allowed by this implementation.
56
+ * @zh 本实现允许的最大 UDP 数据报载荷字节数。
57
+ * @ja この実装で許容する UDP データグラムの最大ペイロードバイト数。
58
+ * @ko 이 구현에서 허용하는 최대 UDP 데이터그램 페이로드 바이트 수.
59
+ */
22
60
  static readonly MaxDatagramSize = 65507;
23
- /** 底层 UDP 套接字句柄。 */
61
+ /**
62
+ * Underlying UDP socket handle.
63
+ * @zh 底层 UDP 套接字句柄。
64
+ * @ja 下位の UDP ソケットハンドル。
65
+ * @ko 기반 UDP 소켓 핸들.
66
+ */
24
67
  declare protected transport?: UdpHandle;
25
68
  /** 是否已绑定端口。 */
26
69
  private bound = false;
@@ -34,13 +77,34 @@ export class UdpSocket extends Socket {
34
77
  private readonly reads = new SerialQueue();
35
78
  /** 发送操作串行队列。 */
36
79
  private readonly writes = new SerialQueue();
37
- /** 创建尚未绑定的 UDP 套接字,默认使用异步阻塞语义。 */
80
+ /**
81
+ * Create an unbound UDP socket with asynchronous blocking semantics
82
+ * by default.
83
+ * @zh 创建尚未绑定的 UDP 套接字,默认使用异步阻塞语义。
84
+ * @ja 未バインドの UDP ソケットを作成します。
85
+ * 既定では非同期ブロッキング動作を使います。
86
+ * @ko 바인딩되지 않은 UDP 소켓을 생성하며 기본적으로 비동기 블로킹 동작을
87
+ * 사용합니다.
88
+ */
38
89
  constructor() { super(SocketType.Udp); }
39
- /** 返回已绑定的本地端口,未绑定时为 0。 */
90
+ /**
91
+ * Return the bound local port, or 0 when unbound.
92
+ * @zh 返回已绑定的本地端口,未绑定时为 0。
93
+ * @ja バインド済みのローカルポートを返し、未バインドなら 0 を返します。
94
+ * @ko 바인딩된 로컬 포트를 반환하며 바인딩되지 않았으면 0입니다.
95
+ */
40
96
  getLocalPort(): number {
41
97
  return this.bound ? this.transport!.address().port : 0;
42
98
  }
43
- /** 异步绑定本地端口和地址;port 为 0 时由系统分配,默认使用 IPv4。 */
99
+ /**
100
+ * Bind a local port and address asynchronously; port 0 lets the system assign
101
+ * a port. Use IPv4 by default.
102
+ * @zh 异步绑定本地端口和地址;port 为 0 时由系统分配,默认使用 IPv4。
103
+ * @ja ローカルポートとアドレスを非同期にバインドします。
104
+ * port が 0 ならシステムが割り当てます。既定では IPv4 を使用します。
105
+ * @ko 로컬 포트와 주소를 비동기로 바인딩합니다. port가 0이면 시스템이
106
+ * 할당하며 기본적으로 IPv4를 사용합니다.
107
+ */
44
108
  async bind(port: number, address: IpAddress = IpAddress.Any): Promise<Status> {
45
109
  uint(port, 65535);
46
110
  if (!(address instanceof IpAddress)) throw new TypeError('Expected IpAddress');
@@ -54,11 +118,24 @@ export class UdpSocket extends Socket {
54
118
  return this.epoch !== generation ? Status.Disconnected
55
119
  : this.bound ? Status.Done : Status.Error;
56
120
  }
57
- /** 接管前拒绝非 UDP 的 Node 传输。 */
121
+ /**
122
+ * Reject non-UDP Node transports before adoption.
123
+ * @zh 接管前拒绝非 UDP 的 Node 传输。
124
+ * @ja 引き継ぐ前に UDP 以外の Node トランスポートを拒否します。
125
+ * @ko 인수 전에 UDP가 아닌 Node 전송 객체를 거부합니다.
126
+ */
58
127
  protected validateHandle(handle: SocketHandle): void {
59
128
  if (!(handle instanceof UdpHandle)) throw new TypeError('Expected Node UDP');
60
129
  }
61
- /** 将分配或接管的 UDP 句柄接入同一数据报队列及绑定状态。 */
130
+ /**
131
+ * Integrate an allocated or adopted UDP handle into the same datagram queue
132
+ * and binding state.
133
+ * @zh 将分配或接管的 UDP 句柄接入同一数据报队列及绑定状态。
134
+ * @ja 割り当てまたは引き継いだ UDP ハンドルを同じデータグラムキューと
135
+ * バインド状態に組み込みます。
136
+ * @ko 할당하거나 인수한 UDP 핸들을 같은 데이터그램 큐와 바인딩 상태에
137
+ * 연결합니다.
138
+ */
62
139
  protected onCreate(): void {
63
140
  const socket = this.transport!;
64
141
  const generation = this.epoch;
@@ -101,15 +178,36 @@ export class UdpSocket extends Socket {
101
178
  };
102
179
  try { socket.address(); listening(); } catch { this.bound = false; }
103
180
  }
104
- /** 关闭 UDP 传输并清空待接收的数据报。 */
181
+ /**
182
+ * Close the UDP transport and clear datagrams pending receipt.
183
+ * @zh 关闭 UDP 传输并清空待接收的数据报。
184
+ * @ja UDP トランスポートを閉じ、受信待ちのデータグラムを消去します。
185
+ * @ko UDP 전송 객체를 닫고 수신 대기 중인 데이터그램을 비웁니다.
186
+ */
105
187
  unbind(): void { this.close(); }
106
- /** 清空旧传输的绑定状态和数据报,旧读取通过代际变化取消。 */
188
+ /**
189
+ * Clear the old transport's binding state and datagrams;
190
+ * the generation change cancels old reads.
191
+ * @zh 清空旧传输的绑定状态和数据报,旧读取通过代际变化取消。
192
+ * @ja 古いトランスポートのバインド状態とデータグラムを消去します。
193
+ * 世代の変更により古い読み取りをキャンセルします。
194
+ * @ko 기존 전송 객체의 바인딩 상태와 데이터그램을 비우며,
195
+ * 세대 변경으로 이전 읽기를 취소합니다.
196
+ */
107
197
  protected onClose(): void {
108
198
  this.bound = false;
109
199
  this.pending = [];
110
200
  this.pendingBytes = 0;
111
201
  }
112
- /** 发送调用时的数据快照为一个数据报;未绑定时按目标地址族自动绑定临时端口。 */
202
+ /**
203
+ * Send a call-time data snapshot as one datagram; if unbound, automatically
204
+ * bind an ephemeral port for the destination address family.
205
+ * @zh 发送调用时的数据快照为一个数据报;未绑定时按目标地址族自动绑定临时端口。
206
+ * @ja 呼び出し時のデータスナップショットを 1 つのデータグラムとして送信します。
207
+ * 未バインドなら宛先アドレスファミリーに応じて一時ポートに自動バインドします。
208
+ * @ko 호출 시점의 데이터 스냅샷을 하나의 데이터그램으로 송신합니다.
209
+ * 바인딩되지 않았으면 대상 주소 계열에 맞는 임시 포트에 자동 바인딩합니다.
210
+ */
113
211
  send(data: Uint8Array | Packet, address: IpAddress, port: number):
114
212
  Promise<Status> {
115
213
  uint(port, 65535);
@@ -144,7 +242,17 @@ export class UdpSocket extends Socket {
144
242
  socket.off('error', onError);
145
243
  }
146
244
  }
147
- /** 接收一个完整数据报;目标字节区过小时丢弃并返回 Error,非阻塞无数据为 NotReady。 */
245
+ /**
246
+ * Receive one complete datagram; discard it and return Error if the
247
+ * destination byte buffer is too small. With no data, nonblocking mode
248
+ * returns NotReady.
249
+ * @zh 接收一个完整数据报;目标字节区过小时丢弃并返回 Error,
250
+ * 非阻塞无数据为 NotReady。
251
+ * @ja 完全なデータグラムを 1 つ受信します。出力先バイト領域が小さすぎる場合は
252
+ * 破棄して Error を返し、非ブロッキングでデータがなければ NotReady を返します。
253
+ * @ko 완전한 데이터그램 하나를 수신합니다. 대상 바이트 버퍼가 너무 작으면
254
+ * 폐기하고 Error를 반환합니다. 논블로킹 모드에서 데이터가 없으면 NotReady입니다.
255
+ */
148
256
  receive(destination: Uint8Array | Packet): Promise<DatagramResult> {
149
257
  const output = destination instanceof Packet ? undefined : bytes(destination);
150
258
  const generation = this.epoch;
@@ -165,9 +273,19 @@ export class UdpSocket extends Socket {
165
273
  remotePort: item.peer.port };
166
274
  });
167
275
  }
168
- /** 返回绑定状态,允许派生类扩展。 */
276
+ /**
277
+ * Return the binding state; derived classes may extend this.
278
+ * @zh 返回绑定状态,允许派生类扩展。
279
+ * @ja バインド状態を返します。派生クラスで拡張できます。
280
+ * @ko 바인딩 상태를 반환하며 파생 클래스에서 확장할 수 있습니다.
281
+ */
169
282
  protected isAlive(): boolean { return this.bound; }
170
- /** 返回待接收数据报和当前绑定对应的就绪位。 */
283
+ /**
284
+ * Return readiness bits for pending datagrams and the current binding.
285
+ * @zh 返回待接收数据报和当前绑定对应的就绪位。
286
+ * @ja 受信待ちデータグラムと現在のバインドに対応する準備状態ビットを返します。
287
+ * @ko 수신 대기 데이터그램과 현재 바인딩에 해당하는 준비 상태 비트를 반환합니다.
288
+ */
171
289
  protected getReadiness(mask: number): number {
172
290
  // eslint-disable-next-line no-bitwise
173
291
  return ((this.pending.length ? 1 : 0) | (this.bound ? 2 : 0)) & mask;
@@ -7,7 +7,12 @@ import {
7
7
  const pi = Math.fround(3.141592654);
8
8
  const tau = Math.fround(pi * 2);
9
9
 
10
- /** SFML's float32 remainder, whose truncated quotient must fit in int32. */
10
+ /**
11
+ * SFML's float32 remainder, whose truncated quotient must fit in int32.
12
+ * @zh SFML 的 float32 余数,截断后的商必须在 int32 范围内。
13
+ * @ja SFML の float32 剰余。切り捨てた商は int32 の範囲内でなければならない。
14
+ * @ko SFML의 float32 나머지. 소수부를 버린 몫은 int32 범위 내여야 한다.
15
+ */
11
16
  export function positiveRemainder(a: number, b: number): number {
12
17
  if (!(b > 0)) throw new RangeError('Angle modulus must be positive');
13
18
  // C++ int has no negative zero, unlike Math.trunc().
@@ -21,14 +26,24 @@ export function positiveRemainder(a: number, b: number): number {
21
26
  return result >= 0 ? result : Math.fround(result + b);
22
27
  }
23
28
 
24
- /** sf::Angle's float32 value, with native ownership created on demand. */
29
+ /**
30
+ * sf::Angle's float32 value, with native ownership created on demand.
31
+ * @zh sf::Angle 的 float32 值,按需创建原生所有权。
32
+ * @ja sf::Angle の float32 値。ネイティブ所有権は必要に応じて作成される。
33
+ * @ko sf::Angle의 float32 값. 네이티브 소유권은 필요할 때 생성된다.
34
+ */
25
35
  export class Angle {
26
36
  readonly [mutableValue] = true;
27
37
  private readonly state = new LazyValue<'angle', Float32Array>(
28
38
  new Float32Array(1), buffer => native.wrapAngle(buffer),
29
39
  );
30
40
 
31
- /** 创建零角度,或复制 source 的角度值。 */
41
+ /**
42
+ * Create a zero angle, or copy the angle value of source.
43
+ * @zh 创建零角度,或复制 source 的角度值。
44
+ * @ja ゼロ角度を作成するか、source の角度値をコピーする。
45
+ * @ko 영각을 생성하거나 source의 각도 값을 복사한다.
46
+ */
32
47
  constructor(source?: ReadonlyValue<Angle>) {
33
48
  if (source !== undefined) {
34
49
  this[angleStorage][0] = source.asRadians();
@@ -43,40 +58,75 @@ export class Angle {
43
58
  return nativeValue(this, angleNative, this.state);
44
59
  }
45
60
 
46
- /** 返回角度制数值,一周为 360 度。 */
61
+ /**
62
+ * Return the value in degrees, with 360 degrees per revolution.
63
+ * @zh 返回角度制数值,一周为 360 度。
64
+ * @ja 度数法の値を返す。1 回転は 360 度。
65
+ * @ko 도 단위 값을 반환한다. 한 바퀴는 360도이다.
66
+ */
47
67
  asDegrees(): number {
48
68
  return Math.fround(this.asRadians() * Math.fround(180 / pi));
49
69
  }
50
70
 
51
- /** 返回弧度制数值,一周为 2π 弧度。 */
71
+ /**
72
+ * Return the value in radians, with 2π radians per revolution.
73
+ * @zh 返回弧度制数值,一周为 2π 弧度。
74
+ * @ja ラジアン値を返す。1 回転は 2π ラジアン。
75
+ * @ko 라디안 단위 값을 반환한다. 한 바퀴는 2π 라디안이다.
76
+ */
52
77
  asRadians(): number {
53
78
  return this[angleStorage][0];
54
79
  }
55
80
 
56
- /** 返回归一化到 [-180°, 180°) 的新角度。 */
81
+ /**
82
+ * Return a new angle normalized to [-180°, 180°).
83
+ * @zh 返回归一化到 [-180°, 180°) 的新角度。
84
+ * @ja [-180°, 180°) に正規化した新しい角度を返す。
85
+ * @ko [-180°, 180°)로 정규화한 새 각도를 반환한다.
86
+ */
57
87
  wrapSigned(): Angle {
58
88
  return radians(Math.fround(
59
89
  positiveRemainder(Math.fround(this.asRadians() + pi), tau) - pi,
60
90
  ));
61
91
  }
62
92
 
63
- /** 返回归一化到 [0°, 360°) 的新角度。 */
93
+ /**
94
+ * Return a new angle normalized to [0°, 360°).
95
+ * @zh 返回归一化到 [0°, 360°) 的新角度。
96
+ * @ja [0°, 360°) に正規化した新しい角度を返す。
97
+ * @ko [0°, 360°)로 정규화한 새 각도를 반환한다.
98
+ */
64
99
  wrapUnsigned(): Angle {
65
100
  return radians(positiveRemainder(this.asRadians(), tau));
66
101
  }
67
102
 
68
- /** 只读的零角度。 */
103
+ /**
104
+ * The read-only zero angle.
105
+ * @zh 只读的零角度。
106
+ * @ja 読み取り専用のゼロ角度。
107
+ * @ko 읽기 전용 영각.
108
+ */
69
109
  static readonly Zero: ReadonlyValue<Angle> = Object.freeze(new Angle());
70
110
  }
71
111
 
72
- /** 从弧度值创建角度,按 float32 精度存储。 */
112
+ /**
113
+ * Create an angle from radians, stored with float32 precision.
114
+ * @zh 从弧度值创建角度,按 float32 精度存储。
115
+ * @ja ラジアン値から角度を作成し、float32 精度で格納する。
116
+ * @ko 라디안 값으로 각도를 생성하고 float32 정밀도로 저장한다.
117
+ */
73
118
  export function radians(angle: number): Angle {
74
119
  const result = new Angle();
75
120
  result[angleStorage][0] = angle;
76
121
  return result;
77
122
  }
78
123
 
79
- /** 从度数创建角度,按 float32 精度存储。 */
124
+ /**
125
+ * Create an angle from degrees, stored with float32 precision.
126
+ * @zh 从度数创建角度,按 float32 精度存储。
127
+ * @ja 度数から角度を作成し、float32 精度で格納する。
128
+ * @ko 도 단위 값으로 각도를 생성하고 float32 정밀도로 저장한다.
129
+ */
80
130
  export function degrees(angle: number): Angle {
81
131
  return radians(Math.fround(angle) * Math.fround(pi / 180));
82
132
  }
@@ -2,12 +2,25 @@ import { hrtime } from 'node:process';
2
2
  import { Time } from './time';
3
3
  import { type ReadonlyValue } from '../internal/value-storage';
4
4
 
5
- /** A pausable monotonic stopwatch, with no native SFML handle. */
5
+ /**
6
+ * A pausable monotonic stopwatch, with no native SFML handle.
7
+ * @zh 可暂停的单调秒表,不持有原生 SFML 句柄。
8
+ * @ja 一時停止可能な単調ストップウォッチ。ネイティブ SFML ハンドルは持たない。
9
+ * @ko 일시 정지 가능한 단조 스톱워치. 네이티브 SFML 핸들을 갖지 않는다.
10
+ */
6
11
  export class Clock {
7
12
  private reference: bigint;
8
13
  private stopped: bigint | undefined;
9
14
 
10
- /** 创建立即开始计时的时钟,或复制 source 当前的计时起点和暂停状态。 */
15
+ /**
16
+ * Create a clock that starts immediately, or copy source's current
17
+ * starting point and paused state.
18
+ * @zh 创建立即开始计时的时钟,或复制 source 当前的计时起点和暂停状态。
19
+ * @ja 直ちに計測を開始する時計を作成するか、source の現在の計測開始点と
20
+ * 一時停止状態をコピーする。
21
+ * @ko 즉시 측정을 시작하는 시계를 생성하거나 source의 현재 측정 시작점과
22
+ * 일시 정지 상태를 복사한다.
23
+ */
11
24
  constructor(source?: ReadonlyValue<Clock>) {
12
25
  if (source !== undefined) {
13
26
  if (!(source instanceof Clock)) throw new TypeError('Expected a Clock');
@@ -18,17 +31,32 @@ export class Clock {
18
31
  }
19
32
  }
20
33
 
21
- /** 返回累计运行时长,不计入通过 stop() 暂停的时间。 */
34
+ /**
35
+ * Return accumulated running time, excluding time paused with stop().
36
+ * @zh 返回累计运行时长,不计入通过 stop() 暂停的时间。
37
+ * @ja stop() による一時停止時間を除いた累積稼働時間を返す。
38
+ * @ko stop()으로 일시 정지한 시간을 제외한 누적 실행 시간을 반환한다.
39
+ */
22
40
  getElapsedTime(): Time {
23
41
  return new Time(((this.stopped ?? hrtime.bigint()) - this.reference) / 1000n);
24
42
  }
25
43
 
26
- /** 返回时钟是否正在计时。 */
44
+ /**
45
+ * Return whether the clock is running.
46
+ * @zh 返回时钟是否正在计时。
47
+ * @ja 時計が計測中かどうかを返す。
48
+ * @ko 시계가 측정 중인지 반환한다.
49
+ */
27
50
  isRunning(): boolean {
28
51
  return this.stopped === undefined;
29
52
  }
30
53
 
31
- /** 恢复计时,保留累计时长;已运行时无操作。 */
54
+ /**
55
+ * Resume timing, preserving accumulated time; do nothing if already running.
56
+ * @zh 恢复计时,保留累计时长;已运行时无操作。
57
+ * @ja 累積時間を保持して計測を再開する。すでに計測中なら何もしない。
58
+ * @ko 누적 시간을 유지하며 측정을 재개한다. 이미 실행 중이면 아무 작업도 안 한다.
59
+ */
32
60
  start(this: Clock): void {
33
61
  if (this.stopped !== undefined) {
34
62
  this.reference += hrtime.bigint() - this.stopped;
@@ -36,17 +64,32 @@ export class Clock {
36
64
  }
37
65
  }
38
66
 
39
- /** 暂停计时,保留累计时长。 */
67
+ /**
68
+ * Pause timing, preserving accumulated time.
69
+ * @zh 暂停计时,保留累计时长。
70
+ * @ja 累積時間を保持して計測を一時停止する。
71
+ * @ko 누적 시간을 유지하며 측정을 일시 정지한다.
72
+ */
40
73
  stop(this: Clock): void {
41
74
  if (this.stopped === undefined) this.stopped = hrtime.bigint();
42
75
  }
43
76
 
44
- /** 清零并开始计时,返回清零前的累计运行时长。 */
77
+ /**
78
+ * Clear and start timing, returning the previous accumulated running time.
79
+ * @zh 清零并开始计时,返回清零前的累计运行时长。
80
+ * @ja ゼロにして計測を開始し、リセット前の累積稼働時間を返す。
81
+ * @ko 초기화 후 측정을 시작하고 초기화 전 누적 실행 시간을 반환한다.
82
+ */
45
83
  restart(this: Clock): Time {
46
84
  return this.resetAt(true);
47
85
  }
48
86
 
49
- /** 清零并暂停计时,返回清零前的累计运行时长。 */
87
+ /**
88
+ * Clear and pause timing, returning the previous accumulated running time.
89
+ * @zh 清零并暂停计时,返回清零前的累计运行时长。
90
+ * @ja ゼロにして計測を一時停止し、リセット前の累積稼働時間を返す。
91
+ * @ko 초기화 후 측정을 일시 정지하고 초기화 전 누적 실행 시간을 반환한다.
92
+ */
50
93
  reset(this: Clock): Time {
51
94
  return this.resetAt(false);
52
95
  }
package/src/system/err.ts CHANGED
@@ -8,7 +8,12 @@ function drainBeforeExit(): void {
8
8
  native.flushErrorOutput();
9
9
  }
10
10
 
11
- /** A singleton Writable whose bytes are written to the actual SFML stream. */
11
+ /**
12
+ * A singleton Writable whose bytes are written to the actual SFML stream.
13
+ * @zh 单例 Writable,其字节写入实际的 SFML 流。
14
+ * @ja 書き込んだバイトが実際の SFML ストリームに渡されるシングルトン Writable。
15
+ * @ko 바이트가 실제 SFML 스트림에 기록되는 싱글턴 Writable.
16
+ */
12
17
  export function err(): Writable {
13
18
  stream ??= new Writable({
14
19
  write(chunk: Buffer, _encoding, complete) {
@@ -24,7 +29,14 @@ export function err(): Writable {
24
29
  return stream;
25
30
  }
26
31
 
27
- /** Process-wide SFML output: Writable redirects, null mutes, undefined resets. */
32
+ /**
33
+ * Process-wide SFML output: Writable redirects, null mutes, undefined resets.
34
+ * @zh 进程级 SFML 输出:Writable 重定向,null 静默,undefined 重置。
35
+ * @ja プロセス全体の SFML 出力。Writable で転送、null で抑止、
36
+ * undefined でリセットする。
37
+ * @ko 프로세스 전체 SFML 출력. Writable은 리디렉션, null은 출력 차단,
38
+ * undefined는 초기화한다.
39
+ */
28
40
  export function setErrorOutput(target?: Writable | null): void {
29
41
  if (target !== undefined && target !== null) {
30
42
  if (!(target instanceof Writable) || target === stream) {
@@ -1,6 +1,16 @@
1
- /** Runtime failure reported by the SFML binding. */
1
+ /**
2
+ * Runtime failure reported by the SFML binding.
3
+ * @zh SFML 绑定报告的运行时错误。
4
+ * @ja SFML バインディングが報告する実行時エラー。
5
+ * @ko SFML 바인딩이 보고하는 런타임 오류.
6
+ */
2
7
  export class SFMLError extends Error {
3
- /** 创建 SFML 运行时错误,message 为错误描述。 */
8
+ /**
9
+ * Create an SFML runtime error with message as the error description.
10
+ * @zh 创建 SFML 运行时错误,message 为错误描述。
11
+ * @ja message をエラー説明とする SFML 実行時エラーを作成する。
12
+ * @ko message를 오류 설명으로 하는 SFML 런타임 오류를 생성한다.
13
+ */
4
14
  constructor(message?: string) {
5
15
  super(message);
6
16
  this.name = 'SFMLError';
@@ -3,13 +3,23 @@ import { open, type FileHandle } from 'node:fs/promises';
3
3
  import { resolve } from 'node:path';
4
4
  import { InputStream } from './input-stream';
5
5
 
6
- /** Seekable asynchronous file input that reads directly into caller buffers. */
6
+ /**
7
+ * Seekable asynchronous file input that reads directly into caller buffers.
8
+ * @zh 可寻址的异步文件输入,直接读取到调用者的缓冲区。
9
+ * @ja 呼び出し元のバッファへ直接読み込む、シーク可能な非同期ファイル入力。
10
+ * @ko 호출자의 버퍼로 직접 읽는 탐색 가능한 비동기 파일 입력.
11
+ */
7
12
  export class FileInputStream extends InputStream {
8
13
  private file?: FileHandle;
9
14
  private position = 0;
10
15
  private pending: Promise<void> = Promise.resolve();
11
16
 
12
- /** Replaces the current file; an I/O failure leaves the stream closed. */
17
+ /**
18
+ * Replaces the current file; an I/O failure leaves the stream closed.
19
+ * @zh 替换当前文件;I/O 失败时流保持关闭状态。
20
+ * @ja 現在のファイルを置き換える。I/O 失敗時はストリームが閉じた状態になる。
21
+ * @ko 현재 파일을 교체한다. I/O 실패 시 스트림은 닫힌 상태가 된다.
22
+ */
13
23
  open(filename: string): Promise<boolean> {
14
24
  if (typeof filename !== 'string' || filename.includes('\0')) {
15
25
  throw new TypeError('Expected a file path without null bytes');
@@ -26,7 +36,16 @@ export class FileInputStream extends InputStream {
26
36
  });
27
37
  }
28
38
 
29
- /** 异步读取到 data 并推进位置;返回字节数,文件末尾为 0n,失败或未打开为 undefined。 */
39
+ /**
40
+ * Read asynchronously into data and advance the position; return the byte
41
+ * count, 0n at EOF, or undefined on failure or if not open.
42
+ * @zh 异步读取到 data 并推进位置;返回字节数,文件末尾为 0n,
43
+ * 失败或未打开为 undefined。
44
+ * @ja data へ非同期で読み込み、位置を進める。バイト数を返し、ファイル末尾では
45
+ * 0n、失敗時または未オープン時は undefined を返す。
46
+ * @ko data로 비동기 읽기 후 위치를 이동한다. 바이트 수를 반환하며 파일 끝에서는
47
+ * 0n, 실패하거나 열리지 않은 경우 undefined를 반환한다.
48
+ */
30
49
  read(data: Uint8Array): Promise<bigint | undefined> {
31
50
  if (!(data instanceof Uint8Array)) {
32
51
  throw new TypeError('Expected a Uint8Array');
@@ -49,7 +68,16 @@ export class FileInputStream extends InputStream {
49
68
  });
50
69
  }
51
70
 
52
- /** 按顺序设置绝对字节位置(0~2^53−1),返回新位置;未打开返回 undefined。 */
71
+ /**
72
+ * Set the absolute byte position (0 to 2^53−1) in operation order and
73
+ * return the new position; return undefined if not open.
74
+ * @zh 按顺序设置绝对字节位置(0~2^53−1),返回新位置;
75
+ * 未打开返回 undefined。
76
+ * @ja 操作順に絶対バイト位置(0~2^53−1)を設定して新しい位置を返す。
77
+ * 未オープン時は undefined を返す。
78
+ * @ko 작업 순서에 따라 절대 바이트 위치(0~2^53−1)를 설정하고 새 위치를 반환한다.
79
+ * 열리지 않은 경우 undefined를 반환한다.
80
+ */
53
81
  seek(position: bigint): Promise<bigint | undefined> {
54
82
  if (typeof position !== 'bigint' || position < 0n ||
55
83
  position > BigInt(Number.MAX_SAFE_INTEGER)) {
@@ -62,13 +90,27 @@ export class FileInputStream extends InputStream {
62
90
  });
63
91
  }
64
92
 
65
- /** 等待之前的操作完成后返回当前字节位置;未打开返回 undefined。 */
93
+ /**
94
+ * Wait for earlier operations, then return the current byte position;
95
+ * return undefined if not open.
96
+ * @zh 等待之前的操作完成后返回当前字节位置;未打开返回 undefined。
97
+ * @ja 先行する操作の完了を待ち、現在のバイト位置を返す。
98
+ * 未オープン時は undefined を返す。
99
+ * @ko 이전 작업이 완료되면 현재 바이트 위치를 반환한다.
100
+ * 열리지 않은 경우 undefined를 반환한다.
101
+ */
66
102
  tell(): Promise<bigint | undefined> {
67
103
  return this.enqueue(() =>
68
104
  (this.file ? BigInt(this.position) : undefined));
69
105
  }
70
106
 
71
- /** 异步返回文件字节数;失败或未打开返回 undefined。 */
107
+ /**
108
+ * Return the file's byte count asynchronously; return undefined on failure
109
+ * or if not open.
110
+ * @zh 异步返回文件字节数;失败或未打开返回 undefined。
111
+ * @ja ファイルのバイト数を非同期で返す。失敗時や未オープン時は undefined。
112
+ * @ko 파일의 바이트 수를 비동기로 반환한다. 실패하거나 열리지 않으면 undefined.
113
+ */
72
114
  getSize(): Promise<bigint | undefined> {
73
115
  return this.enqueue(async () => {
74
116
  if (!this.file) return undefined;
@@ -80,7 +122,12 @@ export class FileInputStream extends InputStream {
80
122
  });
81
123
  }
82
124
 
83
- /** Waits for earlier operations; repeated closes are harmless. */
125
+ /**
126
+ * Waits for earlier operations; repeated closes are harmless.
127
+ * @zh 等待之前的操作完成;重复关闭无害。
128
+ * @ja 先行する操作の完了を待つ。繰り返し閉じても問題ない。
129
+ * @ko 이전 작업의 완료를 기다린다. 반복해서 닫아도 문제없다.
130
+ */
84
131
  close(): Promise<void> {
85
132
  return this.enqueue(() => this.closeFile());
86
133
  }