fca-smart-shankar 12.0.0 → 13.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 (285) hide show
  1. package/.replit +12 -3
  2. package/.upm/store.json +1 -0
  3. package/CHANGELOG.md +2 -0
  4. package/README.md +0 -1
  5. package/generated-icon.png +0 -0
  6. package/index.js +507 -437
  7. package/package.json +378 -42
  8. package/replit.nix +3 -1
  9. package/shankar-fca.json +4 -0
  10. package/src/addUserToGroup.js +3 -3
  11. package/src/changeAdminStatus.js +2 -2
  12. package/src/changeArchivedStatus.js +2 -2
  13. package/src/changeAvatar.js +8 -8
  14. package/src/changeAvatarV2.js +1 -1
  15. package/src/changeBio.js +4 -4
  16. package/src/changeBlockedStatus.js +2 -2
  17. package/src/changeCover.js +2 -2
  18. package/src/changeGroupImage.js +4 -4
  19. package/src/changeName.js +2 -2
  20. package/src/changeNickname.js +2 -2
  21. package/src/changeThreadColor.js +3 -3
  22. package/src/changeThreadEmoji.js +2 -2
  23. package/src/changeUsername.js +3 -3
  24. package/src/createCommentPost.js +5 -5
  25. package/src/createNewGroup.js +5 -5
  26. package/src/createPoll.js +2 -2
  27. package/src/createPost.js +6 -5
  28. package/src/deleteMessage.js +2 -2
  29. package/src/deleteThread.js +2 -2
  30. package/src/editMessage.js +30 -18
  31. package/src/follow.js +8 -8
  32. package/src/forwardAttachment.js +2 -2
  33. package/src/getAccess.js +2 -2
  34. package/src/getAvatarUser.js +2 -2
  35. package/src/getCurrentUserID.js +4 -4
  36. package/src/getFriendsList.js +3 -3
  37. package/src/getMessage.js +2 -2
  38. package/src/getThreadHistory.js +2 -2
  39. package/src/getThreadHistoryDeprecated.js +2 -2
  40. package/src/getThreadInfo.js +1 -1
  41. package/src/getThreadInfoDeprecated.js +2 -2
  42. package/src/getThreadList.js +3 -3
  43. package/src/getThreadListDeprecated.js +3 -3
  44. package/src/getThreadPictures.js +2 -2
  45. package/src/getUID.js +4 -4
  46. package/src/getUserID.js +3 -3
  47. package/src/getUserInfo.js +52 -18
  48. package/src/handleFriendRequest.js +5 -5
  49. package/src/handleMessageRequest.js +2 -2
  50. package/src/httpGet.js +3 -3
  51. package/src/httpPost.js +3 -3
  52. package/src/httpPostFormData.js +3 -3
  53. package/src/listenMqtt.js +648 -659
  54. package/src/listenNotification.js +1 -1
  55. package/src/logout.js +3 -3
  56. package/src/markAsDelivered.js +5 -2
  57. package/src/markAsRead.js +5 -2
  58. package/src/markAsReadAll.js +2 -2
  59. package/src/markAsSeen.js +2 -2
  60. package/src/muteThread.js +2 -2
  61. package/src/refreshFb_dtsg.js +3 -3
  62. package/src/removeUserFromGroup.js +2 -2
  63. package/src/resolvePhotoUrl.js +2 -2
  64. package/src/searchStickers.js +1 -1
  65. package/src/sendMessage.js +11 -8
  66. package/src/sendMessageMqtt.js +4 -4
  67. package/src/sendTypingIndicator.js +14 -5
  68. package/src/sendTypingIndicatorV2.js +1 -1
  69. package/src/setMessageReaction.js +3 -3
  70. package/src/setPostReaction.js +4 -4
  71. package/src/setProfileGuard.js +3 -3
  72. package/src/setStoryReaction.js +1 -1
  73. package/src/setTitle.js +3 -3
  74. package/src/shareContact.js +1 -1
  75. package/src/shareLink.js +1 -1
  76. package/src/stopListenMqtt.js +5 -2
  77. package/src/unfriend.js +2 -2
  78. package/src/unsendMessage.js +2 -2
  79. package/src/uploadAttachment.js +2 -2
  80. package/test/data/shareAttach.js +146 -0
  81. package/test/data/something.mov +0 -0
  82. package/test/data/test.png +0 -0
  83. package/test/data/test.txt +7 -0
  84. package/test/test-page.js +1 -1
  85. package/utils.js +564 -391
  86. package/.cache/nix/binary-cache-v6.sqlite +0 -0
  87. package/.cache/nix/binary-cache-v6.sqlite-journal +0 -0
  88. package/.cache/replit/env/latest +0 -125
  89. package/.cache/replit/env/latest.json +0 -1
  90. package/.cache/replit/modules/nix.res +0 -1
  91. package/.cache/replit/modules/nodejs-20.res +0 -1
  92. package/.cache/replit/modules/replit.res +0 -1
  93. package/.cache/replit/modules.stamp +0 -0
  94. package/.cache/replit/nix/env.json +0 -1
  95. package/.cache/typescript/5.6/node_modules/.package-lock.json +0 -171
  96. package/.cache/typescript/5.6/node_modules/@types/bluebird/LICENSE +0 -21
  97. package/.cache/typescript/5.6/node_modules/@types/bluebird/README.md +0 -15
  98. package/.cache/typescript/5.6/node_modules/@types/bluebird/index.d.ts +0 -1365
  99. package/.cache/typescript/5.6/node_modules/@types/bluebird/package.json +0 -25
  100. package/.cache/typescript/5.6/node_modules/@types/caseless/LICENSE +0 -21
  101. package/.cache/typescript/5.6/node_modules/@types/caseless/README.md +0 -48
  102. package/.cache/typescript/5.6/node_modules/@types/caseless/index.d.ts +0 -29
  103. package/.cache/typescript/5.6/node_modules/@types/caseless/package.json +0 -35
  104. package/.cache/typescript/5.6/node_modules/@types/cheerio/LICENSE +0 -21
  105. package/.cache/typescript/5.6/node_modules/@types/cheerio/README.md +0 -15
  106. package/.cache/typescript/5.6/node_modules/@types/cheerio/index.d.ts +0 -318
  107. package/.cache/typescript/5.6/node_modules/@types/cheerio/package.json +0 -71
  108. package/.cache/typescript/5.6/node_modules/@types/mocha/LICENSE +0 -21
  109. package/.cache/typescript/5.6/node_modules/@types/mocha/README.md +0 -15
  110. package/.cache/typescript/5.6/node_modules/@types/mocha/index.d.ts +0 -2929
  111. package/.cache/typescript/5.6/node_modules/@types/mocha/package.json +0 -56
  112. package/.cache/typescript/5.6/node_modules/@types/node/LICENSE +0 -21
  113. package/.cache/typescript/5.6/node_modules/@types/node/README.md +0 -15
  114. package/.cache/typescript/5.6/node_modules/@types/node/assert/strict.d.ts +0 -8
  115. package/.cache/typescript/5.6/node_modules/@types/node/assert.d.ts +0 -1040
  116. package/.cache/typescript/5.6/node_modules/@types/node/async_hooks.d.ts +0 -541
  117. package/.cache/typescript/5.6/node_modules/@types/node/buffer.buffer.d.ts +0 -385
  118. package/.cache/typescript/5.6/node_modules/@types/node/buffer.d.ts +0 -1933
  119. package/.cache/typescript/5.6/node_modules/@types/node/child_process.d.ts +0 -1549
  120. package/.cache/typescript/5.6/node_modules/@types/node/cluster.d.ts +0 -579
  121. package/.cache/typescript/5.6/node_modules/@types/node/compatibility/disposable.d.ts +0 -16
  122. package/.cache/typescript/5.6/node_modules/@types/node/compatibility/index.d.ts +0 -9
  123. package/.cache/typescript/5.6/node_modules/@types/node/compatibility/indexable.d.ts +0 -23
  124. package/.cache/typescript/5.6/node_modules/@types/node/compatibility/iterators.d.ts +0 -21
  125. package/.cache/typescript/5.6/node_modules/@types/node/console.d.ts +0 -452
  126. package/.cache/typescript/5.6/node_modules/@types/node/constants.d.ts +0 -19
  127. package/.cache/typescript/5.6/node_modules/@types/node/crypto.d.ts +0 -4475
  128. package/.cache/typescript/5.6/node_modules/@types/node/dgram.d.ts +0 -596
  129. package/.cache/typescript/5.6/node_modules/@types/node/diagnostics_channel.d.ts +0 -554
  130. package/.cache/typescript/5.6/node_modules/@types/node/dns/promises.d.ts +0 -476
  131. package/.cache/typescript/5.6/node_modules/@types/node/dns.d.ts +0 -865
  132. package/.cache/typescript/5.6/node_modules/@types/node/dom-events.d.ts +0 -124
  133. package/.cache/typescript/5.6/node_modules/@types/node/domain.d.ts +0 -170
  134. package/.cache/typescript/5.6/node_modules/@types/node/events.d.ts +0 -931
  135. package/.cache/typescript/5.6/node_modules/@types/node/fs/promises.d.ts +0 -1275
  136. package/.cache/typescript/5.6/node_modules/@types/node/fs.d.ts +0 -4396
  137. package/.cache/typescript/5.6/node_modules/@types/node/globals.d.ts +0 -566
  138. package/.cache/typescript/5.6/node_modules/@types/node/globals.typedarray.d.ts +0 -21
  139. package/.cache/typescript/5.6/node_modules/@types/node/http.d.ts +0 -1958
  140. package/.cache/typescript/5.6/node_modules/@types/node/http2.d.ts +0 -2558
  141. package/.cache/typescript/5.6/node_modules/@types/node/https.d.ts +0 -543
  142. package/.cache/typescript/5.6/node_modules/@types/node/index.d.ts +0 -92
  143. package/.cache/typescript/5.6/node_modules/@types/node/inspector.d.ts +0 -3966
  144. package/.cache/typescript/5.6/node_modules/@types/node/module.d.ts +0 -402
  145. package/.cache/typescript/5.6/node_modules/@types/node/net.d.ts +0 -1001
  146. package/.cache/typescript/5.6/node_modules/@types/node/os.d.ts +0 -495
  147. package/.cache/typescript/5.6/node_modules/@types/node/package.json +0 -220
  148. package/.cache/typescript/5.6/node_modules/@types/node/path.d.ts +0 -200
  149. package/.cache/typescript/5.6/node_modules/@types/node/perf_hooks.d.ts +0 -965
  150. package/.cache/typescript/5.6/node_modules/@types/node/process.d.ts +0 -1963
  151. package/.cache/typescript/5.6/node_modules/@types/node/punycode.d.ts +0 -117
  152. package/.cache/typescript/5.6/node_modules/@types/node/querystring.d.ts +0 -153
  153. package/.cache/typescript/5.6/node_modules/@types/node/readline/promises.d.ts +0 -162
  154. package/.cache/typescript/5.6/node_modules/@types/node/readline.d.ts +0 -589
  155. package/.cache/typescript/5.6/node_modules/@types/node/repl.d.ts +0 -430
  156. package/.cache/typescript/5.6/node_modules/@types/node/sea.d.ts +0 -153
  157. package/.cache/typescript/5.6/node_modules/@types/node/sqlite.d.ts +0 -213
  158. package/.cache/typescript/5.6/node_modules/@types/node/stream/consumers.d.ts +0 -12
  159. package/.cache/typescript/5.6/node_modules/@types/node/stream/promises.d.ts +0 -90
  160. package/.cache/typescript/5.6/node_modules/@types/node/stream/web.d.ts +0 -609
  161. package/.cache/typescript/5.6/node_modules/@types/node/stream.d.ts +0 -1726
  162. package/.cache/typescript/5.6/node_modules/@types/node/string_decoder.d.ts +0 -67
  163. package/.cache/typescript/5.6/node_modules/@types/node/test.d.ts +0 -2248
  164. package/.cache/typescript/5.6/node_modules/@types/node/timers/promises.d.ts +0 -97
  165. package/.cache/typescript/5.6/node_modules/@types/node/timers.d.ts +0 -240
  166. package/.cache/typescript/5.6/node_modules/@types/node/tls.d.ts +0 -1226
  167. package/.cache/typescript/5.6/node_modules/@types/node/trace_events.d.ts +0 -197
  168. package/.cache/typescript/5.6/node_modules/@types/node/ts5.6/buffer.buffer.d.ts +0 -385
  169. package/.cache/typescript/5.6/node_modules/@types/node/ts5.6/globals.typedarray.d.ts +0 -19
  170. package/.cache/typescript/5.6/node_modules/@types/node/ts5.6/index.d.ts +0 -92
  171. package/.cache/typescript/5.6/node_modules/@types/node/tty.d.ts +0 -208
  172. package/.cache/typescript/5.6/node_modules/@types/node/url.d.ts +0 -972
  173. package/.cache/typescript/5.6/node_modules/@types/node/util.d.ts +0 -2371
  174. package/.cache/typescript/5.6/node_modules/@types/node/v8.d.ts +0 -808
  175. package/.cache/typescript/5.6/node_modules/@types/node/vm.d.ts +0 -976
  176. package/.cache/typescript/5.6/node_modules/@types/node/wasi.d.ts +0 -181
  177. package/.cache/typescript/5.6/node_modules/@types/node/worker_threads.d.ts +0 -745
  178. package/.cache/typescript/5.6/node_modules/@types/node/zlib.d.ts +0 -539
  179. package/.cache/typescript/5.6/node_modules/@types/request/LICENSE +0 -21
  180. package/.cache/typescript/5.6/node_modules/@types/request/README.md +0 -15
  181. package/.cache/typescript/5.6/node_modules/@types/request/index.d.ts +0 -395
  182. package/.cache/typescript/5.6/node_modules/@types/request/package.json +0 -70
  183. package/.cache/typescript/5.6/node_modules/@types/tough-cookie/LICENSE +0 -21
  184. package/.cache/typescript/5.6/node_modules/@types/tough-cookie/README.md +0 -15
  185. package/.cache/typescript/5.6/node_modules/@types/tough-cookie/index.d.ts +0 -321
  186. package/.cache/typescript/5.6/node_modules/@types/tough-cookie/package.json +0 -35
  187. package/.cache/typescript/5.6/node_modules/asynckit/LICENSE +0 -21
  188. package/.cache/typescript/5.6/node_modules/asynckit/README.md +0 -233
  189. package/.cache/typescript/5.6/node_modules/asynckit/bench.js +0 -76
  190. package/.cache/typescript/5.6/node_modules/asynckit/index.js +0 -6
  191. package/.cache/typescript/5.6/node_modules/asynckit/lib/abort.js +0 -29
  192. package/.cache/typescript/5.6/node_modules/asynckit/lib/async.js +0 -34
  193. package/.cache/typescript/5.6/node_modules/asynckit/lib/defer.js +0 -26
  194. package/.cache/typescript/5.6/node_modules/asynckit/lib/iterate.js +0 -75
  195. package/.cache/typescript/5.6/node_modules/asynckit/lib/readable_asynckit.js +0 -91
  196. package/.cache/typescript/5.6/node_modules/asynckit/lib/readable_parallel.js +0 -25
  197. package/.cache/typescript/5.6/node_modules/asynckit/lib/readable_serial.js +0 -25
  198. package/.cache/typescript/5.6/node_modules/asynckit/lib/readable_serial_ordered.js +0 -29
  199. package/.cache/typescript/5.6/node_modules/asynckit/lib/state.js +0 -37
  200. package/.cache/typescript/5.6/node_modules/asynckit/lib/streamify.js +0 -141
  201. package/.cache/typescript/5.6/node_modules/asynckit/lib/terminator.js +0 -29
  202. package/.cache/typescript/5.6/node_modules/asynckit/package.json +0 -63
  203. package/.cache/typescript/5.6/node_modules/asynckit/parallel.js +0 -43
  204. package/.cache/typescript/5.6/node_modules/asynckit/serial.js +0 -17
  205. package/.cache/typescript/5.6/node_modules/asynckit/serialOrdered.js +0 -75
  206. package/.cache/typescript/5.6/node_modules/asynckit/stream.js +0 -21
  207. package/.cache/typescript/5.6/node_modules/combined-stream/License +0 -19
  208. package/.cache/typescript/5.6/node_modules/combined-stream/Readme.md +0 -138
  209. package/.cache/typescript/5.6/node_modules/combined-stream/lib/combined_stream.js +0 -208
  210. package/.cache/typescript/5.6/node_modules/combined-stream/package.json +0 -25
  211. package/.cache/typescript/5.6/node_modules/combined-stream/yarn.lock +0 -17
  212. package/.cache/typescript/5.6/node_modules/delayed-stream/License +0 -19
  213. package/.cache/typescript/5.6/node_modules/delayed-stream/Makefile +0 -7
  214. package/.cache/typescript/5.6/node_modules/delayed-stream/Readme.md +0 -141
  215. package/.cache/typescript/5.6/node_modules/delayed-stream/lib/delayed_stream.js +0 -107
  216. package/.cache/typescript/5.6/node_modules/delayed-stream/package.json +0 -27
  217. package/.cache/typescript/5.6/node_modules/form-data/License +0 -19
  218. package/.cache/typescript/5.6/node_modules/form-data/Readme.md +0 -350
  219. package/.cache/typescript/5.6/node_modules/form-data/index.d.ts +0 -51
  220. package/.cache/typescript/5.6/node_modules/form-data/lib/browser.js +0 -2
  221. package/.cache/typescript/5.6/node_modules/form-data/lib/form_data.js +0 -484
  222. package/.cache/typescript/5.6/node_modules/form-data/lib/populate.js +0 -10
  223. package/.cache/typescript/5.6/node_modules/form-data/package.json +0 -72
  224. package/.cache/typescript/5.6/node_modules/mime-db/HISTORY.md +0 -507
  225. package/.cache/typescript/5.6/node_modules/mime-db/LICENSE +0 -23
  226. package/.cache/typescript/5.6/node_modules/mime-db/README.md +0 -100
  227. package/.cache/typescript/5.6/node_modules/mime-db/db.json +0 -8519
  228. package/.cache/typescript/5.6/node_modules/mime-db/index.js +0 -12
  229. package/.cache/typescript/5.6/node_modules/mime-db/package.json +0 -60
  230. package/.cache/typescript/5.6/node_modules/mime-types/HISTORY.md +0 -397
  231. package/.cache/typescript/5.6/node_modules/mime-types/LICENSE +0 -23
  232. package/.cache/typescript/5.6/node_modules/mime-types/README.md +0 -113
  233. package/.cache/typescript/5.6/node_modules/mime-types/index.js +0 -188
  234. package/.cache/typescript/5.6/node_modules/mime-types/package.json +0 -44
  235. package/.cache/typescript/5.6/node_modules/safe-buffer/LICENSE +0 -21
  236. package/.cache/typescript/5.6/node_modules/safe-buffer/README.md +0 -584
  237. package/.cache/typescript/5.6/node_modules/safe-buffer/index.d.ts +0 -187
  238. package/.cache/typescript/5.6/node_modules/safe-buffer/index.js +0 -65
  239. package/.cache/typescript/5.6/node_modules/safe-buffer/package.json +0 -51
  240. package/.cache/typescript/5.6/node_modules/types-registry/README.md +0 -2
  241. package/.cache/typescript/5.6/node_modules/types-registry/index.json +0 -1
  242. package/.cache/typescript/5.6/node_modules/types-registry/package.json +0 -20
  243. package/.cache/typescript/5.6/node_modules/undici-types/LICENSE +0 -21
  244. package/.cache/typescript/5.6/node_modules/undici-types/README.md +0 -6
  245. package/.cache/typescript/5.6/node_modules/undici-types/agent.d.ts +0 -31
  246. package/.cache/typescript/5.6/node_modules/undici-types/api.d.ts +0 -43
  247. package/.cache/typescript/5.6/node_modules/undici-types/balanced-pool.d.ts +0 -29
  248. package/.cache/typescript/5.6/node_modules/undici-types/cache.d.ts +0 -36
  249. package/.cache/typescript/5.6/node_modules/undici-types/client.d.ts +0 -108
  250. package/.cache/typescript/5.6/node_modules/undici-types/connector.d.ts +0 -34
  251. package/.cache/typescript/5.6/node_modules/undici-types/content-type.d.ts +0 -21
  252. package/.cache/typescript/5.6/node_modules/undici-types/cookies.d.ts +0 -28
  253. package/.cache/typescript/5.6/node_modules/undici-types/diagnostics-channel.d.ts +0 -66
  254. package/.cache/typescript/5.6/node_modules/undici-types/dispatcher.d.ts +0 -255
  255. package/.cache/typescript/5.6/node_modules/undici-types/env-http-proxy-agent.d.ts +0 -21
  256. package/.cache/typescript/5.6/node_modules/undici-types/errors.d.ts +0 -149
  257. package/.cache/typescript/5.6/node_modules/undici-types/eventsource.d.ts +0 -61
  258. package/.cache/typescript/5.6/node_modules/undici-types/fetch.d.ts +0 -209
  259. package/.cache/typescript/5.6/node_modules/undici-types/file.d.ts +0 -39
  260. package/.cache/typescript/5.6/node_modules/undici-types/filereader.d.ts +0 -54
  261. package/.cache/typescript/5.6/node_modules/undici-types/formdata.d.ts +0 -108
  262. package/.cache/typescript/5.6/node_modules/undici-types/global-dispatcher.d.ts +0 -9
  263. package/.cache/typescript/5.6/node_modules/undici-types/global-origin.d.ts +0 -7
  264. package/.cache/typescript/5.6/node_modules/undici-types/handlers.d.ts +0 -15
  265. package/.cache/typescript/5.6/node_modules/undici-types/header.d.ts +0 -4
  266. package/.cache/typescript/5.6/node_modules/undici-types/index.d.ts +0 -71
  267. package/.cache/typescript/5.6/node_modules/undici-types/interceptors.d.ts +0 -17
  268. package/.cache/typescript/5.6/node_modules/undici-types/mock-agent.d.ts +0 -50
  269. package/.cache/typescript/5.6/node_modules/undici-types/mock-client.d.ts +0 -25
  270. package/.cache/typescript/5.6/node_modules/undici-types/mock-errors.d.ts +0 -12
  271. package/.cache/typescript/5.6/node_modules/undici-types/mock-interceptor.d.ts +0 -93
  272. package/.cache/typescript/5.6/node_modules/undici-types/mock-pool.d.ts +0 -25
  273. package/.cache/typescript/5.6/node_modules/undici-types/package.json +0 -55
  274. package/.cache/typescript/5.6/node_modules/undici-types/patch.d.ts +0 -33
  275. package/.cache/typescript/5.6/node_modules/undici-types/pool-stats.d.ts +0 -19
  276. package/.cache/typescript/5.6/node_modules/undici-types/pool.d.ts +0 -39
  277. package/.cache/typescript/5.6/node_modules/undici-types/proxy-agent.d.ts +0 -28
  278. package/.cache/typescript/5.6/node_modules/undici-types/readable.d.ts +0 -60
  279. package/.cache/typescript/5.6/node_modules/undici-types/retry-agent.d.ts +0 -8
  280. package/.cache/typescript/5.6/node_modules/undici-types/retry-handler.d.ts +0 -116
  281. package/.cache/typescript/5.6/node_modules/undici-types/util.d.ts +0 -18
  282. package/.cache/typescript/5.6/node_modules/undici-types/webidl.d.ts +0 -222
  283. package/.cache/typescript/5.6/node_modules/undici-types/websocket.d.ts +0 -150
  284. package/.cache/typescript/5.6/package-lock.json +0 -183
  285. package/.cache/typescript/5.6/package.json +0 -1
@@ -1,97 +0,0 @@
1
- /**
2
- * The `timers/promises` API provides an alternative set of timer functions
3
- * that return `Promise` objects. The API is accessible via `import timersPromises from 'node:timers/promises'`.
4
- *
5
- * ```js
6
- * import {
7
- * setTimeout,
8
- * setImmediate,
9
- * setInterval,
10
- * } from 'node:timers/promises';
11
- * ```
12
- * @since v15.0.0
13
- */
14
- declare module "timers/promises" {
15
- import { TimerOptions } from "node:timers";
16
- /**
17
- * ```js
18
- * import {
19
- * setTimeout,
20
- * } from 'node:timers/promises';
21
- *
22
- * const res = await setTimeout(100, 'result');
23
- *
24
- * console.log(res); // Prints 'result'
25
- * ```
26
- * @since v15.0.0
27
- * @param [delay=1] The number of milliseconds to wait before fulfilling the promise.
28
- * @param value A value with which the promise is fulfilled.
29
- */
30
- function setTimeout<T = void>(delay?: number, value?: T, options?: TimerOptions): Promise<T>;
31
- /**
32
- * ```js
33
- * import {
34
- * setImmediate,
35
- * } from 'node:timers/promises';
36
- *
37
- * const res = await setImmediate('result');
38
- *
39
- * console.log(res); // Prints 'result'
40
- * ```
41
- * @since v15.0.0
42
- * @param value A value with which the promise is fulfilled.
43
- */
44
- function setImmediate<T = void>(value?: T, options?: TimerOptions): Promise<T>;
45
- /**
46
- * Returns an async iterator that generates values in an interval of `delay` ms.
47
- * If `ref` is `true`, you need to call `next()` of async iterator explicitly
48
- * or implicitly to keep the event loop alive.
49
- *
50
- * ```js
51
- * import {
52
- * setInterval,
53
- * } from 'node:timers/promises';
54
- *
55
- * const interval = 100;
56
- * for await (const startTime of setInterval(interval, Date.now())) {
57
- * const now = Date.now();
58
- * console.log(now);
59
- * if ((now - startTime) > 1000)
60
- * break;
61
- * }
62
- * console.log(Date.now());
63
- * ```
64
- * @since v15.9.0
65
- */
66
- function setInterval<T = void>(delay?: number, value?: T, options?: TimerOptions): AsyncIterable<T>;
67
- interface Scheduler {
68
- /**
69
- * An experimental API defined by the [Scheduling APIs](https://github.com/WICG/scheduling-apis) draft specification being developed as a standard Web Platform API.
70
- *
71
- * Calling `timersPromises.scheduler.wait(delay, options)` is roughly equivalent to calling `timersPromises.setTimeout(delay, undefined, options)` except that the `ref`
72
- * option is not supported.
73
- *
74
- * ```js
75
- * import { scheduler } from 'node:timers/promises';
76
- *
77
- * await scheduler.wait(1000); // Wait one second before continuing
78
- * ```
79
- * @since v16.14.0
80
- * @experimental
81
- * @param [delay=1] The number of milliseconds to wait before fulfilling the promise.
82
- */
83
- wait: (delay?: number, options?: TimerOptions) => Promise<void>;
84
- /**
85
- * An experimental API defined by the [Scheduling APIs](https://nodejs.org/docs/latest-v20.x/api/async_hooks.html#promise-execution-tracking) draft specification
86
- * being developed as a standard Web Platform API.
87
- * Calling `timersPromises.scheduler.yield()` is equivalent to calling `timersPromises.setImmediate()` with no arguments.
88
- * @since v16.14.0
89
- * @experimental
90
- */
91
- yield: () => Promise<void>;
92
- }
93
- const scheduler: Scheduler;
94
- }
95
- declare module "node:timers/promises" {
96
- export * from "timers/promises";
97
- }
@@ -1,240 +0,0 @@
1
- /**
2
- * The `timer` module exposes a global API for scheduling functions to
3
- * be called at some future period of time. Because the timer functions are
4
- * globals, there is no need to import `node:timers` to use the API.
5
- *
6
- * The timer functions within Node.js implement a similar API as the timers API
7
- * provided by Web Browsers but use a different internal implementation that is
8
- * built around the Node.js [Event Loop](https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/#setimmediate-vs-settimeout).
9
- * @see [source](https://github.com/nodejs/node/blob/v22.x/lib/timers.js)
10
- */
11
- declare module "timers" {
12
- import { Abortable } from "node:events";
13
- import {
14
- setImmediate as setImmediatePromise,
15
- setInterval as setIntervalPromise,
16
- setTimeout as setTimeoutPromise,
17
- } from "node:timers/promises";
18
- interface TimerOptions extends Abortable {
19
- /**
20
- * Set to `false` to indicate that the scheduled `Timeout`
21
- * should not require the Node.js event loop to remain active.
22
- * @default true
23
- */
24
- ref?: boolean | undefined;
25
- }
26
- let setTimeout: typeof global.setTimeout;
27
- let clearTimeout: typeof global.clearTimeout;
28
- let setInterval: typeof global.setInterval;
29
- let clearInterval: typeof global.clearInterval;
30
- let setImmediate: typeof global.setImmediate;
31
- let clearImmediate: typeof global.clearImmediate;
32
- global {
33
- namespace NodeJS {
34
- // compatibility with older typings
35
- interface Timer extends RefCounted {
36
- hasRef(): boolean;
37
- refresh(): this;
38
- [Symbol.toPrimitive](): number;
39
- }
40
- /**
41
- * This object is created internally and is returned from `setImmediate()`. It
42
- * can be passed to `clearImmediate()` in order to cancel the scheduled
43
- * actions.
44
- *
45
- * By default, when an immediate is scheduled, the Node.js event loop will continue
46
- * running as long as the immediate is active. The `Immediate` object returned by `setImmediate()` exports both `immediate.ref()` and `immediate.unref()` functions that can be used to
47
- * control this default behavior.
48
- */
49
- class Immediate implements RefCounted {
50
- /**
51
- * When called, requests that the Node.js event loop _not_ exit so long as the `Immediate` is active. Calling `immediate.ref()` multiple times will have no
52
- * effect.
53
- *
54
- * By default, all `Immediate` objects are "ref'ed", making it normally unnecessary
55
- * to call `immediate.ref()` unless `immediate.unref()` had been called previously.
56
- * @since v9.7.0
57
- * @return a reference to `immediate`
58
- */
59
- ref(): this;
60
- /**
61
- * When called, the active `Immediate` object will not require the Node.js event
62
- * loop to remain active. If there is no other activity keeping the event loop
63
- * running, the process may exit before the `Immediate` object's callback is
64
- * invoked. Calling `immediate.unref()` multiple times will have no effect.
65
- * @since v9.7.0
66
- * @return a reference to `immediate`
67
- */
68
- unref(): this;
69
- /**
70
- * If true, the `Immediate` object will keep the Node.js event loop active.
71
- * @since v11.0.0
72
- */
73
- hasRef(): boolean;
74
- _onImmediate: Function; // to distinguish it from the Timeout class
75
- /**
76
- * Cancels the immediate. This is similar to calling `clearImmediate()`.
77
- * @since v20.5.0
78
- */
79
- [Symbol.dispose](): void;
80
- }
81
- /**
82
- * This object is created internally and is returned from `setTimeout()` and `setInterval()`. It can be passed to either `clearTimeout()` or `clearInterval()` in order to cancel the
83
- * scheduled actions.
84
- *
85
- * By default, when a timer is scheduled using either `setTimeout()` or `setInterval()`, the Node.js event loop will continue running as long as the
86
- * timer is active. Each of the `Timeout` objects returned by these functions
87
- * export both `timeout.ref()` and `timeout.unref()` functions that can be used to
88
- * control this default behavior.
89
- */
90
- class Timeout implements Timer {
91
- /**
92
- * When called, requests that the Node.js event loop _not_ exit so long as the`Timeout` is active. Calling `timeout.ref()` multiple times will have no effect.
93
- *
94
- * By default, all `Timeout` objects are "ref'ed", making it normally unnecessary
95
- * to call `timeout.ref()` unless `timeout.unref()` had been called previously.
96
- * @since v0.9.1
97
- * @return a reference to `timeout`
98
- */
99
- ref(): this;
100
- /**
101
- * When called, the active `Timeout` object will not require the Node.js event loop
102
- * to remain active. If there is no other activity keeping the event loop running,
103
- * the process may exit before the `Timeout` object's callback is invoked. Calling `timeout.unref()` multiple times will have no effect.
104
- * @since v0.9.1
105
- * @return a reference to `timeout`
106
- */
107
- unref(): this;
108
- /**
109
- * If true, the `Timeout` object will keep the Node.js event loop active.
110
- * @since v11.0.0
111
- */
112
- hasRef(): boolean;
113
- /**
114
- * Sets the timer's start time to the current time, and reschedules the timer to
115
- * call its callback at the previously specified duration adjusted to the current
116
- * time. This is useful for refreshing a timer without allocating a new
117
- * JavaScript object.
118
- *
119
- * Using this on a timer that has already called its callback will reactivate the
120
- * timer.
121
- * @since v10.2.0
122
- * @return a reference to `timeout`
123
- */
124
- refresh(): this;
125
- [Symbol.toPrimitive](): number;
126
- /**
127
- * Cancels the timeout.
128
- * @since v20.5.0
129
- */
130
- [Symbol.dispose](): void;
131
- }
132
- }
133
- /**
134
- * Schedules execution of a one-time `callback` after `delay` milliseconds.
135
- *
136
- * The `callback` will likely not be invoked in precisely `delay` milliseconds.
137
- * Node.js makes no guarantees about the exact timing of when callbacks will fire,
138
- * nor of their ordering. The callback will be called as close as possible to the
139
- * time specified.
140
- *
141
- * When `delay` is larger than `2147483647` or less than `1`, the `delay` will be set to `1`. Non-integer delays are truncated to an integer.
142
- *
143
- * If `callback` is not a function, a `TypeError` will be thrown.
144
- *
145
- * This method has a custom variant for promises that is available using `timersPromises.setTimeout()`.
146
- * @since v0.0.1
147
- * @param callback The function to call when the timer elapses.
148
- * @param [delay=1] The number of milliseconds to wait before calling the `callback`.
149
- * @param args Optional arguments to pass when the `callback` is called.
150
- * @return for use with {@link clearTimeout}
151
- */
152
- function setTimeout<TArgs extends any[]>(
153
- callback: (...args: TArgs) => void,
154
- ms?: number,
155
- ...args: TArgs
156
- ): NodeJS.Timeout;
157
- // util.promisify no rest args compability
158
- // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
159
- function setTimeout(callback: (args: void) => void, ms?: number): NodeJS.Timeout;
160
- namespace setTimeout {
161
- const __promisify__: typeof setTimeoutPromise;
162
- }
163
- /**
164
- * Cancels a `Timeout` object created by `setTimeout()`.
165
- * @since v0.0.1
166
- * @param timeout A `Timeout` object as returned by {@link setTimeout} or the `primitive` of the `Timeout` object as a string or a number.
167
- */
168
- function clearTimeout(timeoutId: NodeJS.Timeout | string | number | undefined): void;
169
- /**
170
- * Schedules repeated execution of `callback` every `delay` milliseconds.
171
- *
172
- * When `delay` is larger than `2147483647` or less than `1`, the `delay` will be
173
- * set to `1`. Non-integer delays are truncated to an integer.
174
- *
175
- * If `callback` is not a function, a `TypeError` will be thrown.
176
- *
177
- * This method has a custom variant for promises that is available using `timersPromises.setInterval()`.
178
- * @since v0.0.1
179
- * @param callback The function to call when the timer elapses.
180
- * @param [delay=1] The number of milliseconds to wait before calling the `callback`.
181
- * @param args Optional arguments to pass when the `callback` is called.
182
- * @return for use with {@link clearInterval}
183
- */
184
- function setInterval<TArgs extends any[]>(
185
- callback: (...args: TArgs) => void,
186
- ms?: number,
187
- ...args: TArgs
188
- ): NodeJS.Timeout;
189
- // util.promisify no rest args compability
190
- // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
191
- function setInterval(callback: (args: void) => void, ms?: number): NodeJS.Timeout;
192
- namespace setInterval {
193
- const __promisify__: typeof setIntervalPromise;
194
- }
195
- /**
196
- * Cancels a `Timeout` object created by `setInterval()`.
197
- * @since v0.0.1
198
- * @param timeout A `Timeout` object as returned by {@link setInterval} or the `primitive` of the `Timeout` object as a string or a number.
199
- */
200
- function clearInterval(intervalId: NodeJS.Timeout | string | number | undefined): void;
201
- /**
202
- * Schedules the "immediate" execution of the `callback` after I/O events'
203
- * callbacks.
204
- *
205
- * When multiple calls to `setImmediate()` are made, the `callback` functions are
206
- * queued for execution in the order in which they are created. The entire callback
207
- * queue is processed every event loop iteration. If an immediate timer is queued
208
- * from inside an executing callback, that timer will not be triggered until the
209
- * next event loop iteration.
210
- *
211
- * If `callback` is not a function, a `TypeError` will be thrown.
212
- *
213
- * This method has a custom variant for promises that is available using `timersPromises.setImmediate()`.
214
- * @since v0.9.1
215
- * @param callback The function to call at the end of this turn of the Node.js `Event Loop`
216
- * @param args Optional arguments to pass when the `callback` is called.
217
- * @return for use with {@link clearImmediate}
218
- */
219
- function setImmediate<TArgs extends any[]>(
220
- callback: (...args: TArgs) => void,
221
- ...args: TArgs
222
- ): NodeJS.Immediate;
223
- // util.promisify no rest args compability
224
- // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
225
- function setImmediate(callback: (args: void) => void): NodeJS.Immediate;
226
- namespace setImmediate {
227
- const __promisify__: typeof setImmediatePromise;
228
- }
229
- /**
230
- * Cancels an `Immediate` object created by `setImmediate()`.
231
- * @since v0.9.1
232
- * @param immediate An `Immediate` object as returned by {@link setImmediate}.
233
- */
234
- function clearImmediate(immediateId: NodeJS.Immediate | undefined): void;
235
- function queueMicrotask(callback: () => void): void;
236
- }
237
- }
238
- declare module "node:timers" {
239
- export * from "timers";
240
- }