zai-fca 1.0.7

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.

Potentially problematic release.


This version of zai-fca might be problematic. Click here for more details.

Files changed (264) hide show
  1. package/.cache/replit/env/latest +56 -0
  2. package/.cache/replit/env/latest.json +1 -0
  3. package/.cache/replit/modules/nodejs-20.res +1 -0
  4. package/.cache/replit/modules/replit.res +1 -0
  5. package/.cache/replit/modules.stamp +0 -0
  6. package/.cache/typescript/5.6/node_modules/.package-lock.json +178 -0
  7. package/.cache/typescript/5.6/node_modules/@types/bluebird/LICENSE +21 -0
  8. package/.cache/typescript/5.6/node_modules/@types/bluebird/README.md +15 -0
  9. package/.cache/typescript/5.6/node_modules/@types/bluebird/index.d.ts +1365 -0
  10. package/.cache/typescript/5.6/node_modules/@types/bluebird/package.json +25 -0
  11. package/.cache/typescript/5.6/node_modules/@types/caseless/LICENSE +21 -0
  12. package/.cache/typescript/5.6/node_modules/@types/caseless/README.md +48 -0
  13. package/.cache/typescript/5.6/node_modules/@types/caseless/index.d.ts +29 -0
  14. package/.cache/typescript/5.6/node_modules/@types/caseless/package.json +35 -0
  15. package/.cache/typescript/5.6/node_modules/@types/mocha/LICENSE +21 -0
  16. package/.cache/typescript/5.6/node_modules/@types/mocha/README.md +15 -0
  17. package/.cache/typescript/5.6/node_modules/@types/mocha/index.d.ts +2929 -0
  18. package/.cache/typescript/5.6/node_modules/@types/mocha/package.json +56 -0
  19. package/.cache/typescript/5.6/node_modules/@types/node/LICENSE +21 -0
  20. package/.cache/typescript/5.6/node_modules/@types/node/README.md +15 -0
  21. package/.cache/typescript/5.6/node_modules/@types/node/assert/strict.d.ts +8 -0
  22. package/.cache/typescript/5.6/node_modules/@types/node/assert.d.ts +1040 -0
  23. package/.cache/typescript/5.6/node_modules/@types/node/async_hooks.d.ts +541 -0
  24. package/.cache/typescript/5.6/node_modules/@types/node/buffer.buffer.d.ts +385 -0
  25. package/.cache/typescript/5.6/node_modules/@types/node/buffer.d.ts +1933 -0
  26. package/.cache/typescript/5.6/node_modules/@types/node/child_process.d.ts +1549 -0
  27. package/.cache/typescript/5.6/node_modules/@types/node/cluster.d.ts +579 -0
  28. package/.cache/typescript/5.6/node_modules/@types/node/compatibility/disposable.d.ts +16 -0
  29. package/.cache/typescript/5.6/node_modules/@types/node/compatibility/index.d.ts +9 -0
  30. package/.cache/typescript/5.6/node_modules/@types/node/compatibility/indexable.d.ts +23 -0
  31. package/.cache/typescript/5.6/node_modules/@types/node/compatibility/iterators.d.ts +21 -0
  32. package/.cache/typescript/5.6/node_modules/@types/node/console.d.ts +452 -0
  33. package/.cache/typescript/5.6/node_modules/@types/node/constants.d.ts +19 -0
  34. package/.cache/typescript/5.6/node_modules/@types/node/crypto.d.ts +4475 -0
  35. package/.cache/typescript/5.6/node_modules/@types/node/dgram.d.ts +596 -0
  36. package/.cache/typescript/5.6/node_modules/@types/node/diagnostics_channel.d.ts +554 -0
  37. package/.cache/typescript/5.6/node_modules/@types/node/dns/promises.d.ts +476 -0
  38. package/.cache/typescript/5.6/node_modules/@types/node/dns.d.ts +865 -0
  39. package/.cache/typescript/5.6/node_modules/@types/node/dom-events.d.ts +124 -0
  40. package/.cache/typescript/5.6/node_modules/@types/node/domain.d.ts +170 -0
  41. package/.cache/typescript/5.6/node_modules/@types/node/events.d.ts +931 -0
  42. package/.cache/typescript/5.6/node_modules/@types/node/fs/promises.d.ts +1275 -0
  43. package/.cache/typescript/5.6/node_modules/@types/node/fs.d.ts +4396 -0
  44. package/.cache/typescript/5.6/node_modules/@types/node/globals.d.ts +566 -0
  45. package/.cache/typescript/5.6/node_modules/@types/node/globals.typedarray.d.ts +21 -0
  46. package/.cache/typescript/5.6/node_modules/@types/node/http.d.ts +1958 -0
  47. package/.cache/typescript/5.6/node_modules/@types/node/http2.d.ts +2558 -0
  48. package/.cache/typescript/5.6/node_modules/@types/node/https.d.ts +543 -0
  49. package/.cache/typescript/5.6/node_modules/@types/node/index.d.ts +92 -0
  50. package/.cache/typescript/5.6/node_modules/@types/node/inspector.d.ts +3966 -0
  51. package/.cache/typescript/5.6/node_modules/@types/node/module.d.ts +402 -0
  52. package/.cache/typescript/5.6/node_modules/@types/node/net.d.ts +1001 -0
  53. package/.cache/typescript/5.6/node_modules/@types/node/os.d.ts +495 -0
  54. package/.cache/typescript/5.6/node_modules/@types/node/package.json +220 -0
  55. package/.cache/typescript/5.6/node_modules/@types/node/path.d.ts +200 -0
  56. package/.cache/typescript/5.6/node_modules/@types/node/perf_hooks.d.ts +965 -0
  57. package/.cache/typescript/5.6/node_modules/@types/node/process.d.ts +1963 -0
  58. package/.cache/typescript/5.6/node_modules/@types/node/punycode.d.ts +117 -0
  59. package/.cache/typescript/5.6/node_modules/@types/node/querystring.d.ts +153 -0
  60. package/.cache/typescript/5.6/node_modules/@types/node/readline/promises.d.ts +162 -0
  61. package/.cache/typescript/5.6/node_modules/@types/node/readline.d.ts +589 -0
  62. package/.cache/typescript/5.6/node_modules/@types/node/repl.d.ts +430 -0
  63. package/.cache/typescript/5.6/node_modules/@types/node/sea.d.ts +153 -0
  64. package/.cache/typescript/5.6/node_modules/@types/node/sqlite.d.ts +213 -0
  65. package/.cache/typescript/5.6/node_modules/@types/node/stream/consumers.d.ts +12 -0
  66. package/.cache/typescript/5.6/node_modules/@types/node/stream/promises.d.ts +90 -0
  67. package/.cache/typescript/5.6/node_modules/@types/node/stream/web.d.ts +609 -0
  68. package/.cache/typescript/5.6/node_modules/@types/node/stream.d.ts +1726 -0
  69. package/.cache/typescript/5.6/node_modules/@types/node/string_decoder.d.ts +67 -0
  70. package/.cache/typescript/5.6/node_modules/@types/node/test.d.ts +2248 -0
  71. package/.cache/typescript/5.6/node_modules/@types/node/timers/promises.d.ts +97 -0
  72. package/.cache/typescript/5.6/node_modules/@types/node/timers.d.ts +240 -0
  73. package/.cache/typescript/5.6/node_modules/@types/node/tls.d.ts +1226 -0
  74. package/.cache/typescript/5.6/node_modules/@types/node/trace_events.d.ts +197 -0
  75. package/.cache/typescript/5.6/node_modules/@types/node/ts5.6/buffer.buffer.d.ts +385 -0
  76. package/.cache/typescript/5.6/node_modules/@types/node/ts5.6/globals.typedarray.d.ts +19 -0
  77. package/.cache/typescript/5.6/node_modules/@types/node/ts5.6/index.d.ts +92 -0
  78. package/.cache/typescript/5.6/node_modules/@types/node/tty.d.ts +208 -0
  79. package/.cache/typescript/5.6/node_modules/@types/node/url.d.ts +972 -0
  80. package/.cache/typescript/5.6/node_modules/@types/node/util.d.ts +2371 -0
  81. package/.cache/typescript/5.6/node_modules/@types/node/v8.d.ts +808 -0
  82. package/.cache/typescript/5.6/node_modules/@types/node/vm.d.ts +976 -0
  83. package/.cache/typescript/5.6/node_modules/@types/node/wasi.d.ts +181 -0
  84. package/.cache/typescript/5.6/node_modules/@types/node/worker_threads.d.ts +745 -0
  85. package/.cache/typescript/5.6/node_modules/@types/node/zlib.d.ts +539 -0
  86. package/.cache/typescript/5.6/node_modules/@types/node-cron/LICENSE +21 -0
  87. package/.cache/typescript/5.6/node_modules/@types/node-cron/README.md +76 -0
  88. package/.cache/typescript/5.6/node_modules/@types/node-cron/index.d.ts +57 -0
  89. package/.cache/typescript/5.6/node_modules/@types/node-cron/package.json +50 -0
  90. package/.cache/typescript/5.6/node_modules/@types/npmlog/LICENSE +21 -0
  91. package/.cache/typescript/5.6/node_modules/@types/npmlog/README.md +15 -0
  92. package/.cache/typescript/5.6/node_modules/@types/npmlog/index.d.ts +84 -0
  93. package/.cache/typescript/5.6/node_modules/@types/npmlog/package.json +32 -0
  94. package/.cache/typescript/5.6/node_modules/@types/request/LICENSE +21 -0
  95. package/.cache/typescript/5.6/node_modules/@types/request/README.md +15 -0
  96. package/.cache/typescript/5.6/node_modules/@types/request/index.d.ts +395 -0
  97. package/.cache/typescript/5.6/node_modules/@types/request/package.json +70 -0
  98. package/.cache/typescript/5.6/node_modules/@types/tough-cookie/LICENSE +21 -0
  99. package/.cache/typescript/5.6/node_modules/@types/tough-cookie/README.md +15 -0
  100. package/.cache/typescript/5.6/node_modules/@types/tough-cookie/index.d.ts +321 -0
  101. package/.cache/typescript/5.6/node_modules/@types/tough-cookie/package.json +35 -0
  102. package/.cache/typescript/5.6/node_modules/asynckit/LICENSE +21 -0
  103. package/.cache/typescript/5.6/node_modules/asynckit/README.md +233 -0
  104. package/.cache/typescript/5.6/node_modules/asynckit/bench.js +76 -0
  105. package/.cache/typescript/5.6/node_modules/asynckit/index.js +6 -0
  106. package/.cache/typescript/5.6/node_modules/asynckit/lib/abort.js +29 -0
  107. package/.cache/typescript/5.6/node_modules/asynckit/lib/async.js +34 -0
  108. package/.cache/typescript/5.6/node_modules/asynckit/lib/defer.js +26 -0
  109. package/.cache/typescript/5.6/node_modules/asynckit/lib/iterate.js +75 -0
  110. package/.cache/typescript/5.6/node_modules/asynckit/lib/readable_asynckit.js +91 -0
  111. package/.cache/typescript/5.6/node_modules/asynckit/lib/readable_parallel.js +25 -0
  112. package/.cache/typescript/5.6/node_modules/asynckit/lib/readable_serial.js +25 -0
  113. package/.cache/typescript/5.6/node_modules/asynckit/lib/readable_serial_ordered.js +29 -0
  114. package/.cache/typescript/5.6/node_modules/asynckit/lib/state.js +37 -0
  115. package/.cache/typescript/5.6/node_modules/asynckit/lib/streamify.js +141 -0
  116. package/.cache/typescript/5.6/node_modules/asynckit/lib/terminator.js +29 -0
  117. package/.cache/typescript/5.6/node_modules/asynckit/package.json +63 -0
  118. package/.cache/typescript/5.6/node_modules/asynckit/parallel.js +43 -0
  119. package/.cache/typescript/5.6/node_modules/asynckit/serial.js +17 -0
  120. package/.cache/typescript/5.6/node_modules/asynckit/serialOrdered.js +75 -0
  121. package/.cache/typescript/5.6/node_modules/asynckit/stream.js +21 -0
  122. package/.cache/typescript/5.6/node_modules/combined-stream/License +19 -0
  123. package/.cache/typescript/5.6/node_modules/combined-stream/Readme.md +138 -0
  124. package/.cache/typescript/5.6/node_modules/combined-stream/lib/combined_stream.js +208 -0
  125. package/.cache/typescript/5.6/node_modules/combined-stream/package.json +25 -0
  126. package/.cache/typescript/5.6/node_modules/combined-stream/yarn.lock +17 -0
  127. package/.cache/typescript/5.6/node_modules/delayed-stream/License +19 -0
  128. package/.cache/typescript/5.6/node_modules/delayed-stream/Makefile +7 -0
  129. package/.cache/typescript/5.6/node_modules/delayed-stream/Readme.md +141 -0
  130. package/.cache/typescript/5.6/node_modules/delayed-stream/lib/delayed_stream.js +107 -0
  131. package/.cache/typescript/5.6/node_modules/delayed-stream/package.json +27 -0
  132. package/.cache/typescript/5.6/node_modules/form-data/License +19 -0
  133. package/.cache/typescript/5.6/node_modules/form-data/Readme.md +350 -0
  134. package/.cache/typescript/5.6/node_modules/form-data/index.d.ts +51 -0
  135. package/.cache/typescript/5.6/node_modules/form-data/lib/browser.js +2 -0
  136. package/.cache/typescript/5.6/node_modules/form-data/lib/form_data.js +484 -0
  137. package/.cache/typescript/5.6/node_modules/form-data/lib/populate.js +10 -0
  138. package/.cache/typescript/5.6/node_modules/form-data/package.json +72 -0
  139. package/.cache/typescript/5.6/node_modules/mime-db/HISTORY.md +507 -0
  140. package/.cache/typescript/5.6/node_modules/mime-db/LICENSE +23 -0
  141. package/.cache/typescript/5.6/node_modules/mime-db/README.md +100 -0
  142. package/.cache/typescript/5.6/node_modules/mime-db/db.json +8519 -0
  143. package/.cache/typescript/5.6/node_modules/mime-db/index.js +12 -0
  144. package/.cache/typescript/5.6/node_modules/mime-db/package.json +60 -0
  145. package/.cache/typescript/5.6/node_modules/mime-types/HISTORY.md +397 -0
  146. package/.cache/typescript/5.6/node_modules/mime-types/LICENSE +23 -0
  147. package/.cache/typescript/5.6/node_modules/mime-types/README.md +113 -0
  148. package/.cache/typescript/5.6/node_modules/mime-types/index.js +188 -0
  149. package/.cache/typescript/5.6/node_modules/mime-types/package.json +44 -0
  150. package/.cache/typescript/5.6/node_modules/safe-buffer/LICENSE +21 -0
  151. package/.cache/typescript/5.6/node_modules/safe-buffer/README.md +584 -0
  152. package/.cache/typescript/5.6/node_modules/safe-buffer/index.d.ts +187 -0
  153. package/.cache/typescript/5.6/node_modules/safe-buffer/index.js +65 -0
  154. package/.cache/typescript/5.6/node_modules/safe-buffer/package.json +51 -0
  155. package/.cache/typescript/5.6/node_modules/types-registry/README.md +2 -0
  156. package/.cache/typescript/5.6/node_modules/types-registry/index.json +1 -0
  157. package/.cache/typescript/5.6/node_modules/types-registry/package.json +20 -0
  158. package/.cache/typescript/5.6/node_modules/undici-types/LICENSE +21 -0
  159. package/.cache/typescript/5.6/node_modules/undici-types/README.md +6 -0
  160. package/.cache/typescript/5.6/node_modules/undici-types/agent.d.ts +31 -0
  161. package/.cache/typescript/5.6/node_modules/undici-types/api.d.ts +43 -0
  162. package/.cache/typescript/5.6/node_modules/undici-types/balanced-pool.d.ts +29 -0
  163. package/.cache/typescript/5.6/node_modules/undici-types/cache.d.ts +36 -0
  164. package/.cache/typescript/5.6/node_modules/undici-types/client.d.ts +108 -0
  165. package/.cache/typescript/5.6/node_modules/undici-types/connector.d.ts +34 -0
  166. package/.cache/typescript/5.6/node_modules/undici-types/content-type.d.ts +21 -0
  167. package/.cache/typescript/5.6/node_modules/undici-types/cookies.d.ts +28 -0
  168. package/.cache/typescript/5.6/node_modules/undici-types/diagnostics-channel.d.ts +66 -0
  169. package/.cache/typescript/5.6/node_modules/undici-types/dispatcher.d.ts +255 -0
  170. package/.cache/typescript/5.6/node_modules/undici-types/env-http-proxy-agent.d.ts +21 -0
  171. package/.cache/typescript/5.6/node_modules/undici-types/errors.d.ts +149 -0
  172. package/.cache/typescript/5.6/node_modules/undici-types/eventsource.d.ts +61 -0
  173. package/.cache/typescript/5.6/node_modules/undici-types/fetch.d.ts +209 -0
  174. package/.cache/typescript/5.6/node_modules/undici-types/file.d.ts +39 -0
  175. package/.cache/typescript/5.6/node_modules/undici-types/filereader.d.ts +54 -0
  176. package/.cache/typescript/5.6/node_modules/undici-types/formdata.d.ts +108 -0
  177. package/.cache/typescript/5.6/node_modules/undici-types/global-dispatcher.d.ts +9 -0
  178. package/.cache/typescript/5.6/node_modules/undici-types/global-origin.d.ts +7 -0
  179. package/.cache/typescript/5.6/node_modules/undici-types/handlers.d.ts +15 -0
  180. package/.cache/typescript/5.6/node_modules/undici-types/header.d.ts +4 -0
  181. package/.cache/typescript/5.6/node_modules/undici-types/index.d.ts +71 -0
  182. package/.cache/typescript/5.6/node_modules/undici-types/interceptors.d.ts +17 -0
  183. package/.cache/typescript/5.6/node_modules/undici-types/mock-agent.d.ts +50 -0
  184. package/.cache/typescript/5.6/node_modules/undici-types/mock-client.d.ts +25 -0
  185. package/.cache/typescript/5.6/node_modules/undici-types/mock-errors.d.ts +12 -0
  186. package/.cache/typescript/5.6/node_modules/undici-types/mock-interceptor.d.ts +93 -0
  187. package/.cache/typescript/5.6/node_modules/undici-types/mock-pool.d.ts +25 -0
  188. package/.cache/typescript/5.6/node_modules/undici-types/package.json +55 -0
  189. package/.cache/typescript/5.6/node_modules/undici-types/patch.d.ts +33 -0
  190. package/.cache/typescript/5.6/node_modules/undici-types/pool-stats.d.ts +19 -0
  191. package/.cache/typescript/5.6/node_modules/undici-types/pool.d.ts +39 -0
  192. package/.cache/typescript/5.6/node_modules/undici-types/proxy-agent.d.ts +28 -0
  193. package/.cache/typescript/5.6/node_modules/undici-types/readable.d.ts +60 -0
  194. package/.cache/typescript/5.6/node_modules/undici-types/retry-agent.d.ts +8 -0
  195. package/.cache/typescript/5.6/node_modules/undici-types/retry-handler.d.ts +116 -0
  196. package/.cache/typescript/5.6/node_modules/undici-types/util.d.ts +18 -0
  197. package/.cache/typescript/5.6/node_modules/undici-types/webidl.d.ts +222 -0
  198. package/.cache/typescript/5.6/node_modules/undici-types/websocket.d.ts +150 -0
  199. package/.cache/typescript/5.6/package-lock.json +190 -0
  200. package/.cache/typescript/5.6/package.json +1 -0
  201. package/.replit +4 -0
  202. package/.upm/store.json +1 -0
  203. package/LICENSE +21 -0
  204. package/README.md +289 -0
  205. package/index.js +460 -0
  206. package/package.json +45 -0
  207. package/src/Screenshot.js +83 -0
  208. package/src/addExternalModule.js +15 -0
  209. package/src/addUserToGroup.js +77 -0
  210. package/src/changeAdminStatus.js +47 -0
  211. package/src/changeArchivedStatus.js +41 -0
  212. package/src/changeAvt.js +85 -0
  213. package/src/changeBio.js +65 -0
  214. package/src/changeBlockedStatus.js +36 -0
  215. package/src/changeGroupImage.js +106 -0
  216. package/src/changeNickname.js +45 -0
  217. package/src/changeThreadColor.js +61 -0
  218. package/src/changeThreadEmoji.js +41 -0
  219. package/src/createNewGroup.js +70 -0
  220. package/src/createPoll.js +59 -0
  221. package/src/createPost.js +277 -0
  222. package/src/deleteMessage.js +44 -0
  223. package/src/deleteThread.js +42 -0
  224. package/src/forwardAttachment.js +47 -0
  225. package/src/getCurrentUserID.js +7 -0
  226. package/src/getEmojiUrl.js +27 -0
  227. package/src/getFriendsList.js +73 -0
  228. package/src/getThreadHistory.js +537 -0
  229. package/src/getThreadHistoryDeprecated.js +71 -0
  230. package/src/getThreadInfo.js +232 -0
  231. package/src/getThreadInfoDeprecated.js +56 -0
  232. package/src/getThreadList.js +213 -0
  233. package/src/getThreadListDeprecated.js +46 -0
  234. package/src/getThreadPictures.js +59 -0
  235. package/src/getUID.js +119 -0
  236. package/src/getUserID.js +61 -0
  237. package/src/getUserInfo.js +66 -0
  238. package/src/handleFriendRequest.js +46 -0
  239. package/src/handleMessageRequest.js +47 -0
  240. package/src/httpGet.js +49 -0
  241. package/src/httpPost.js +48 -0
  242. package/src/listenMqtt.js +827 -0
  243. package/src/listenMqtt.txt +827 -0
  244. package/src/logout.js +68 -0
  245. package/src/markAsDelivered.js +47 -0
  246. package/src/markAsRead.js +70 -0
  247. package/src/markAsReadAll.js +40 -0
  248. package/src/markAsSeen.js +48 -0
  249. package/src/muteThread.js +45 -0
  250. package/src/postFormData.txt +46 -0
  251. package/src/removeUserFromGroup.js +45 -0
  252. package/src/resolvePhotoUrl.js +36 -0
  253. package/src/searchForThread.js +42 -0
  254. package/src/sendMessage.js +329 -0
  255. package/src/sendTypingIndicator.js +70 -0
  256. package/src/setMessageReaction.js +109 -0
  257. package/src/setPostReaction.js +102 -0
  258. package/src/setTitle.js +70 -0
  259. package/src/shareContact.js +46 -0
  260. package/src/shareLink.js +62 -0
  261. package/src/threadColors.js +41 -0
  262. package/src/unfriend.js +42 -0
  263. package/src/unsendMessage.js +39 -0
  264. package/utils.js +2876 -0
@@ -0,0 +1,92 @@
1
+ /**
2
+ * License for programmatically and manually incorporated
3
+ * documentation aka. `JSDoc` from https://github.com/nodejs/node/tree/master/doc
4
+ *
5
+ * Copyright Node.js contributors. All rights reserved.
6
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ * of this software and associated documentation files (the "Software"), to
8
+ * deal in the Software without restriction, including without limitation the
9
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10
+ * sell copies of the Software, and to permit persons to whom the Software is
11
+ * furnished to do so, subject to the following conditions:
12
+ *
13
+ * The above copyright notice and this permission notice shall be included in
14
+ * all copies or substantial portions of the Software.
15
+ *
16
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22
+ * IN THE SOFTWARE.
23
+ */
24
+
25
+ // NOTE: These definitions support Node.js and TypeScript 4.9 through 5.6.
26
+
27
+ // Reference required TypeScript libs:
28
+ /// <reference lib="es2020" />
29
+
30
+ // TypeScript backwards-compatibility definitions:
31
+ /// <reference path="../compatibility/index.d.ts" />
32
+
33
+ // Definitions specific to TypeScript 4.9 through 5.6:
34
+ /// <reference path="./globals.typedarray.d.ts" />
35
+ /// <reference path="./buffer.buffer.d.ts" />
36
+
37
+ // Definitions for Node.js modules that are not specific to any version of TypeScript:
38
+ /// <reference path="../globals.d.ts" />
39
+ /// <reference path="../assert.d.ts" />
40
+ /// <reference path="../assert/strict.d.ts" />
41
+ /// <reference path="../async_hooks.d.ts" />
42
+ /// <reference path="../buffer.d.ts" />
43
+ /// <reference path="../child_process.d.ts" />
44
+ /// <reference path="../cluster.d.ts" />
45
+ /// <reference path="../console.d.ts" />
46
+ /// <reference path="../constants.d.ts" />
47
+ /// <reference path="../crypto.d.ts" />
48
+ /// <reference path="../dgram.d.ts" />
49
+ /// <reference path="../diagnostics_channel.d.ts" />
50
+ /// <reference path="../dns.d.ts" />
51
+ /// <reference path="../dns/promises.d.ts" />
52
+ /// <reference path="../dns/promises.d.ts" />
53
+ /// <reference path="../domain.d.ts" />
54
+ /// <reference path="../dom-events.d.ts" />
55
+ /// <reference path="../events.d.ts" />
56
+ /// <reference path="../fs.d.ts" />
57
+ /// <reference path="../fs/promises.d.ts" />
58
+ /// <reference path="../http.d.ts" />
59
+ /// <reference path="../http2.d.ts" />
60
+ /// <reference path="../https.d.ts" />
61
+ /// <reference path="../inspector.d.ts" />
62
+ /// <reference path="../module.d.ts" />
63
+ /// <reference path="../net.d.ts" />
64
+ /// <reference path="../os.d.ts" />
65
+ /// <reference path="../path.d.ts" />
66
+ /// <reference path="../perf_hooks.d.ts" />
67
+ /// <reference path="../process.d.ts" />
68
+ /// <reference path="../punycode.d.ts" />
69
+ /// <reference path="../querystring.d.ts" />
70
+ /// <reference path="../readline.d.ts" />
71
+ /// <reference path="../readline/promises.d.ts" />
72
+ /// <reference path="../repl.d.ts" />
73
+ /// <reference path="../sea.d.ts" />
74
+ /// <reference path="../sqlite.d.ts" />
75
+ /// <reference path="../stream.d.ts" />
76
+ /// <reference path="../stream/promises.d.ts" />
77
+ /// <reference path="../stream/consumers.d.ts" />
78
+ /// <reference path="../stream/web.d.ts" />
79
+ /// <reference path="../string_decoder.d.ts" />
80
+ /// <reference path="../test.d.ts" />
81
+ /// <reference path="../timers.d.ts" />
82
+ /// <reference path="../timers/promises.d.ts" />
83
+ /// <reference path="../tls.d.ts" />
84
+ /// <reference path="../trace_events.d.ts" />
85
+ /// <reference path="../tty.d.ts" />
86
+ /// <reference path="../url.d.ts" />
87
+ /// <reference path="../util.d.ts" />
88
+ /// <reference path="../v8.d.ts" />
89
+ /// <reference path="../vm.d.ts" />
90
+ /// <reference path="../wasi.d.ts" />
91
+ /// <reference path="../worker_threads.d.ts" />
92
+ /// <reference path="../zlib.d.ts" />
@@ -0,0 +1,208 @@
1
+ /**
2
+ * The `node:tty` module provides the `tty.ReadStream` and `tty.WriteStream` classes. In most cases, it will not be necessary or possible to use this module
3
+ * directly. However, it can be accessed using:
4
+ *
5
+ * ```js
6
+ * import tty from 'node:tty';
7
+ * ```
8
+ *
9
+ * When Node.js detects that it is being run with a text terminal ("TTY")
10
+ * attached, `process.stdin` will, by default, be initialized as an instance of `tty.ReadStream` and both `process.stdout` and `process.stderr` will, by
11
+ * default, be instances of `tty.WriteStream`. The preferred method of determining
12
+ * whether Node.js is being run within a TTY context is to check that the value of
13
+ * the `process.stdout.isTTY` property is `true`:
14
+ *
15
+ * ```console
16
+ * $ node -p -e "Boolean(process.stdout.isTTY)"
17
+ * true
18
+ * $ node -p -e "Boolean(process.stdout.isTTY)" | cat
19
+ * false
20
+ * ```
21
+ *
22
+ * In most cases, there should be little to no reason for an application to
23
+ * manually create instances of the `tty.ReadStream` and `tty.WriteStream` classes.
24
+ * @see [source](https://github.com/nodejs/node/blob/v22.x/lib/tty.js)
25
+ */
26
+ declare module "tty" {
27
+ import * as net from "node:net";
28
+ /**
29
+ * The `tty.isatty()` method returns `true` if the given `fd` is associated with
30
+ * a TTY and `false` if it is not, including whenever `fd` is not a non-negative
31
+ * integer.
32
+ * @since v0.5.8
33
+ * @param fd A numeric file descriptor
34
+ */
35
+ function isatty(fd: number): boolean;
36
+ /**
37
+ * Represents the readable side of a TTY. In normal circumstances `process.stdin` will be the only `tty.ReadStream` instance in a Node.js
38
+ * process and there should be no reason to create additional instances.
39
+ * @since v0.5.8
40
+ */
41
+ class ReadStream extends net.Socket {
42
+ constructor(fd: number, options?: net.SocketConstructorOpts);
43
+ /**
44
+ * A `boolean` that is `true` if the TTY is currently configured to operate as a
45
+ * raw device.
46
+ *
47
+ * This flag is always `false` when a process starts, even if the terminal is
48
+ * operating in raw mode. Its value will change with subsequent calls to `setRawMode`.
49
+ * @since v0.7.7
50
+ */
51
+ isRaw: boolean;
52
+ /**
53
+ * Allows configuration of `tty.ReadStream` so that it operates as a raw device.
54
+ *
55
+ * When in raw mode, input is always available character-by-character, not
56
+ * including modifiers. Additionally, all special processing of characters by the
57
+ * terminal is disabled, including echoing input
58
+ * characters. Ctrl+C will no longer cause a `SIGINT` when
59
+ * in this mode.
60
+ * @since v0.7.7
61
+ * @param mode If `true`, configures the `tty.ReadStream` to operate as a raw device. If `false`, configures the `tty.ReadStream` to operate in its default mode. The `readStream.isRaw`
62
+ * property will be set to the resulting mode.
63
+ * @return The read stream instance.
64
+ */
65
+ setRawMode(mode: boolean): this;
66
+ /**
67
+ * A `boolean` that is always `true` for `tty.ReadStream` instances.
68
+ * @since v0.5.8
69
+ */
70
+ isTTY: boolean;
71
+ }
72
+ /**
73
+ * -1 - to the left from cursor
74
+ * 0 - the entire line
75
+ * 1 - to the right from cursor
76
+ */
77
+ type Direction = -1 | 0 | 1;
78
+ /**
79
+ * Represents the writable side of a TTY. In normal circumstances, `process.stdout` and `process.stderr` will be the only`tty.WriteStream` instances created for a Node.js process and there
80
+ * should be no reason to create additional instances.
81
+ * @since v0.5.8
82
+ */
83
+ class WriteStream extends net.Socket {
84
+ constructor(fd: number);
85
+ addListener(event: string, listener: (...args: any[]) => void): this;
86
+ addListener(event: "resize", listener: () => void): this;
87
+ emit(event: string | symbol, ...args: any[]): boolean;
88
+ emit(event: "resize"): boolean;
89
+ on(event: string, listener: (...args: any[]) => void): this;
90
+ on(event: "resize", listener: () => void): this;
91
+ once(event: string, listener: (...args: any[]) => void): this;
92
+ once(event: "resize", listener: () => void): this;
93
+ prependListener(event: string, listener: (...args: any[]) => void): this;
94
+ prependListener(event: "resize", listener: () => void): this;
95
+ prependOnceListener(event: string, listener: (...args: any[]) => void): this;
96
+ prependOnceListener(event: "resize", listener: () => void): this;
97
+ /**
98
+ * `writeStream.clearLine()` clears the current line of this `WriteStream` in a
99
+ * direction identified by `dir`.
100
+ * @since v0.7.7
101
+ * @param callback Invoked once the operation completes.
102
+ * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
103
+ */
104
+ clearLine(dir: Direction, callback?: () => void): boolean;
105
+ /**
106
+ * `writeStream.clearScreenDown()` clears this `WriteStream` from the current
107
+ * cursor down.
108
+ * @since v0.7.7
109
+ * @param callback Invoked once the operation completes.
110
+ * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
111
+ */
112
+ clearScreenDown(callback?: () => void): boolean;
113
+ /**
114
+ * `writeStream.cursorTo()` moves this `WriteStream`'s cursor to the specified
115
+ * position.
116
+ * @since v0.7.7
117
+ * @param callback Invoked once the operation completes.
118
+ * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
119
+ */
120
+ cursorTo(x: number, y?: number, callback?: () => void): boolean;
121
+ cursorTo(x: number, callback: () => void): boolean;
122
+ /**
123
+ * `writeStream.moveCursor()` moves this `WriteStream`'s cursor _relative_ to its
124
+ * current position.
125
+ * @since v0.7.7
126
+ * @param callback Invoked once the operation completes.
127
+ * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
128
+ */
129
+ moveCursor(dx: number, dy: number, callback?: () => void): boolean;
130
+ /**
131
+ * Returns:
132
+ *
133
+ * * `1` for 2,
134
+ * * `4` for 16,
135
+ * * `8` for 256,
136
+ * * `24` for 16,777,216 colors supported.
137
+ *
138
+ * Use this to determine what colors the terminal supports. Due to the nature of
139
+ * colors in terminals it is possible to either have false positives or false
140
+ * negatives. It depends on process information and the environment variables that
141
+ * may lie about what terminal is used.
142
+ * It is possible to pass in an `env` object to simulate the usage of a specific
143
+ * terminal. This can be useful to check how specific environment settings behave.
144
+ *
145
+ * To enforce a specific color support, use one of the below environment settings.
146
+ *
147
+ * * 2 colors: `FORCE_COLOR = 0` (Disables colors)
148
+ * * 16 colors: `FORCE_COLOR = 1`
149
+ * * 256 colors: `FORCE_COLOR = 2`
150
+ * * 16,777,216 colors: `FORCE_COLOR = 3`
151
+ *
152
+ * Disabling color support is also possible by using the `NO_COLOR` and `NODE_DISABLE_COLORS` environment variables.
153
+ * @since v9.9.0
154
+ * @param [env=process.env] An object containing the environment variables to check. This enables simulating the usage of a specific terminal.
155
+ */
156
+ getColorDepth(env?: object): number;
157
+ /**
158
+ * Returns `true` if the `writeStream` supports at least as many colors as provided
159
+ * in `count`. Minimum support is 2 (black and white).
160
+ *
161
+ * This has the same false positives and negatives as described in `writeStream.getColorDepth()`.
162
+ *
163
+ * ```js
164
+ * process.stdout.hasColors();
165
+ * // Returns true or false depending on if `stdout` supports at least 16 colors.
166
+ * process.stdout.hasColors(256);
167
+ * // Returns true or false depending on if `stdout` supports at least 256 colors.
168
+ * process.stdout.hasColors({ TMUX: '1' });
169
+ * // Returns true.
170
+ * process.stdout.hasColors(2 ** 24, { TMUX: '1' });
171
+ * // Returns false (the environment setting pretends to support 2 ** 8 colors).
172
+ * ```
173
+ * @since v11.13.0, v10.16.0
174
+ * @param [count=16] The number of colors that are requested (minimum 2).
175
+ * @param [env=process.env] An object containing the environment variables to check. This enables simulating the usage of a specific terminal.
176
+ */
177
+ hasColors(count?: number): boolean;
178
+ hasColors(env?: object): boolean;
179
+ hasColors(count: number, env?: object): boolean;
180
+ /**
181
+ * `writeStream.getWindowSize()` returns the size of the TTY
182
+ * corresponding to this `WriteStream`. The array is of the type `[numColumns, numRows]` where `numColumns` and `numRows` represent the number
183
+ * of columns and rows in the corresponding TTY.
184
+ * @since v0.7.7
185
+ */
186
+ getWindowSize(): [number, number];
187
+ /**
188
+ * A `number` specifying the number of columns the TTY currently has. This property
189
+ * is updated whenever the `'resize'` event is emitted.
190
+ * @since v0.7.7
191
+ */
192
+ columns: number;
193
+ /**
194
+ * A `number` specifying the number of rows the TTY currently has. This property
195
+ * is updated whenever the `'resize'` event is emitted.
196
+ * @since v0.7.7
197
+ */
198
+ rows: number;
199
+ /**
200
+ * A `boolean` that is always `true`.
201
+ * @since v0.5.8
202
+ */
203
+ isTTY: boolean;
204
+ }
205
+ }
206
+ declare module "node:tty" {
207
+ export * from "tty";
208
+ }