@buape/carbon 0.1.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 (428) hide show
  1. package/.turbo/turbo-build.log +5 -0
  2. package/.turbo/turbo-dev.log +12 -0
  3. package/.turbo/turbo-docs.log +10 -0
  4. package/CHANGELOG.md +14 -0
  5. package/LICENSE +21 -0
  6. package/README.md +45 -0
  7. package/dist/package.json +18 -0
  8. package/dist/src/abstracts/AnySelectMenu.d.ts +31 -0
  9. package/dist/src/abstracts/AnySelectMenu.d.ts.map +1 -0
  10. package/dist/src/abstracts/AnySelectMenu.js +19 -0
  11. package/dist/src/abstracts/AnySelectMenu.js.map +1 -0
  12. package/dist/src/abstracts/AnySelectMenuInteraction.d.ts +12 -0
  13. package/dist/src/abstracts/AnySelectMenuInteraction.d.ts.map +1 -0
  14. package/dist/src/abstracts/AnySelectMenuInteraction.js +21 -0
  15. package/dist/src/abstracts/AnySelectMenuInteraction.js.map +1 -0
  16. package/dist/src/abstracts/Base.d.ts +10 -0
  17. package/dist/src/abstracts/Base.d.ts.map +1 -0
  18. package/dist/src/abstracts/Base.js +11 -0
  19. package/dist/src/abstracts/Base.js.map +1 -0
  20. package/dist/src/abstracts/BaseChannel.d.ts +44 -0
  21. package/dist/src/abstracts/BaseChannel.d.ts.map +1 -0
  22. package/dist/src/abstracts/BaseChannel.js +58 -0
  23. package/dist/src/abstracts/BaseChannel.js.map +1 -0
  24. package/dist/src/abstracts/BaseCommand.d.ts +58 -0
  25. package/dist/src/abstracts/BaseCommand.d.ts.map +1 -0
  26. package/dist/src/abstracts/BaseCommand.js +69 -0
  27. package/dist/src/abstracts/BaseCommand.js.map +1 -0
  28. package/dist/src/abstracts/BaseComponent.d.ts +34 -0
  29. package/dist/src/abstracts/BaseComponent.d.ts.map +1 -0
  30. package/dist/src/abstracts/BaseComponent.js +30 -0
  31. package/dist/src/abstracts/BaseComponent.js.map +1 -0
  32. package/dist/src/abstracts/BaseComponentInteraction.d.ts +9 -0
  33. package/dist/src/abstracts/BaseComponentInteraction.d.ts.map +1 -0
  34. package/dist/src/abstracts/BaseComponentInteraction.js +14 -0
  35. package/dist/src/abstracts/BaseComponentInteraction.js.map +1 -0
  36. package/dist/src/abstracts/BaseGuildChannel.d.ts +68 -0
  37. package/dist/src/abstracts/BaseGuildChannel.d.ts.map +1 -0
  38. package/dist/src/abstracts/BaseGuildChannel.js +130 -0
  39. package/dist/src/abstracts/BaseGuildChannel.js.map +1 -0
  40. package/dist/src/abstracts/BaseGuildTextChannel.d.ts +42 -0
  41. package/dist/src/abstracts/BaseGuildTextChannel.d.ts.map +1 -0
  42. package/dist/src/abstracts/BaseGuildTextChannel.js +61 -0
  43. package/dist/src/abstracts/BaseGuildTextChannel.js.map +1 -0
  44. package/dist/src/abstracts/BaseInteraction.d.ts +87 -0
  45. package/dist/src/abstracts/BaseInteraction.d.ts.map +1 -0
  46. package/dist/src/abstracts/BaseInteraction.js +101 -0
  47. package/dist/src/abstracts/BaseInteraction.js.map +1 -0
  48. package/dist/src/abstracts/ButtonInteraction.d.ts +8 -0
  49. package/dist/src/abstracts/ButtonInteraction.d.ts.map +1 -0
  50. package/dist/src/abstracts/ButtonInteraction.js +18 -0
  51. package/dist/src/abstracts/ButtonInteraction.js.map +1 -0
  52. package/dist/src/abstracts/ChannelSelectMenuInteraction.d.ts +7 -0
  53. package/dist/src/abstracts/ChannelSelectMenuInteraction.d.ts.map +1 -0
  54. package/dist/src/abstracts/ChannelSelectMenuInteraction.js +11 -0
  55. package/dist/src/abstracts/ChannelSelectMenuInteraction.js.map +1 -0
  56. package/dist/src/abstracts/CommandHandler.d.ts +6 -0
  57. package/dist/src/abstracts/CommandHandler.d.ts.map +1 -0
  58. package/dist/src/abstracts/CommandHandler.js +65 -0
  59. package/dist/src/abstracts/CommandHandler.js.map +1 -0
  60. package/dist/src/abstracts/CommandInteraction.d.ts +15 -0
  61. package/dist/src/abstracts/CommandInteraction.d.ts.map +1 -0
  62. package/dist/src/abstracts/CommandInteraction.js +60 -0
  63. package/dist/src/abstracts/CommandInteraction.js.map +1 -0
  64. package/dist/src/abstracts/ComponentHandler.d.ts +6 -0
  65. package/dist/src/abstracts/ComponentHandler.d.ts.map +1 -0
  66. package/dist/src/abstracts/ComponentHandler.js +64 -0
  67. package/dist/src/abstracts/ComponentHandler.js.map +1 -0
  68. package/dist/src/abstracts/GuildThreadOnlyChannel.d.ts +42 -0
  69. package/dist/src/abstracts/GuildThreadOnlyChannel.d.ts.map +1 -0
  70. package/dist/src/abstracts/GuildThreadOnlyChannel.js +54 -0
  71. package/dist/src/abstracts/GuildThreadOnlyChannel.js.map +1 -0
  72. package/dist/src/abstracts/MentionableSelectMenuInteraction.d.ts +8 -0
  73. package/dist/src/abstracts/MentionableSelectMenuInteraction.d.ts.map +1 -0
  74. package/dist/src/abstracts/MentionableSelectMenuInteraction.js +15 -0
  75. package/dist/src/abstracts/MentionableSelectMenuInteraction.js.map +1 -0
  76. package/dist/src/abstracts/RoleSelectMenuInteraction.d.ts +8 -0
  77. package/dist/src/abstracts/RoleSelectMenuInteraction.d.ts.map +1 -0
  78. package/dist/src/abstracts/RoleSelectMenuInteraction.js +14 -0
  79. package/dist/src/abstracts/RoleSelectMenuInteraction.js.map +1 -0
  80. package/dist/src/abstracts/StringSelectMenuInteraction.d.ts +8 -0
  81. package/dist/src/abstracts/StringSelectMenuInteraction.d.ts.map +1 -0
  82. package/dist/src/abstracts/StringSelectMenuInteraction.js +14 -0
  83. package/dist/src/abstracts/StringSelectMenuInteraction.js.map +1 -0
  84. package/dist/src/abstracts/UserSelectMenuInteraction.d.ts +8 -0
  85. package/dist/src/abstracts/UserSelectMenuInteraction.d.ts.map +1 -0
  86. package/dist/src/abstracts/UserSelectMenuInteraction.js +14 -0
  87. package/dist/src/abstracts/UserSelectMenuInteraction.js.map +1 -0
  88. package/dist/src/classes/Button.d.ts +53 -0
  89. package/dist/src/classes/Button.d.ts.map +1 -0
  90. package/dist/src/classes/Button.js +55 -0
  91. package/dist/src/classes/Button.js.map +1 -0
  92. package/dist/src/classes/ChannelSelectMenu.d.ts +15 -0
  93. package/dist/src/classes/ChannelSelectMenu.d.ts.map +1 -0
  94. package/dist/src/classes/ChannelSelectMenu.js +15 -0
  95. package/dist/src/classes/ChannelSelectMenu.js.map +1 -0
  96. package/dist/src/classes/Client.d.ts +117 -0
  97. package/dist/src/classes/Client.d.ts.map +1 -0
  98. package/dist/src/classes/Client.js +170 -0
  99. package/dist/src/classes/Client.js.map +1 -0
  100. package/dist/src/classes/Command.d.ts +35 -0
  101. package/dist/src/classes/Command.d.ts.map +1 -0
  102. package/dist/src/classes/Command.js +31 -0
  103. package/dist/src/classes/Command.js.map +1 -0
  104. package/dist/src/classes/CommandWithSubcommandGroups.d.ts +22 -0
  105. package/dist/src/classes/CommandWithSubcommandGroups.d.ts.map +1 -0
  106. package/dist/src/classes/CommandWithSubcommandGroups.js +31 -0
  107. package/dist/src/classes/CommandWithSubcommandGroups.js.map +1 -0
  108. package/dist/src/classes/CommandWithSubcommands.d.ts +19 -0
  109. package/dist/src/classes/CommandWithSubcommands.d.ts.map +1 -0
  110. package/dist/src/classes/CommandWithSubcommands.js +21 -0
  111. package/dist/src/classes/CommandWithSubcommands.js.map +1 -0
  112. package/dist/src/classes/MentionableSelectMenu.d.ts +13 -0
  113. package/dist/src/classes/MentionableSelectMenu.d.ts.map +1 -0
  114. package/dist/src/classes/MentionableSelectMenu.js +13 -0
  115. package/dist/src/classes/MentionableSelectMenu.js.map +1 -0
  116. package/dist/src/classes/Paginator.d.ts +3 -0
  117. package/dist/src/classes/Paginator.d.ts.map +1 -0
  118. package/dist/src/classes/Paginator.js +3 -0
  119. package/dist/src/classes/Paginator.js.map +1 -0
  120. package/dist/src/classes/RoleSelectMenu.d.ts +13 -0
  121. package/dist/src/classes/RoleSelectMenu.d.ts.map +1 -0
  122. package/dist/src/classes/RoleSelectMenu.js +13 -0
  123. package/dist/src/classes/RoleSelectMenu.js.map +1 -0
  124. package/dist/src/classes/Row.d.ts +27 -0
  125. package/dist/src/classes/Row.d.ts.map +1 -0
  126. package/dist/src/classes/Row.js +39 -0
  127. package/dist/src/classes/Row.js.map +1 -0
  128. package/dist/src/classes/StringSelectMenu.d.ts +13 -0
  129. package/dist/src/classes/StringSelectMenu.d.ts.map +1 -0
  130. package/dist/src/classes/StringSelectMenu.js +12 -0
  131. package/dist/src/classes/StringSelectMenu.js.map +1 -0
  132. package/dist/src/classes/UserSelectMenu.d.ts +13 -0
  133. package/dist/src/classes/UserSelectMenu.d.ts.map +1 -0
  134. package/dist/src/classes/UserSelectMenu.js +13 -0
  135. package/dist/src/classes/UserSelectMenu.js.map +1 -0
  136. package/dist/src/factories/channelFactory.d.ts +13 -0
  137. package/dist/src/factories/channelFactory.d.ts.map +1 -0
  138. package/dist/src/factories/channelFactory.js +39 -0
  139. package/dist/src/factories/channelFactory.js.map +1 -0
  140. package/dist/src/index.d.ts +49 -0
  141. package/dist/src/index.d.ts.map +1 -0
  142. package/dist/src/index.js +55 -0
  143. package/dist/src/index.js.map +1 -0
  144. package/dist/src/internals/AutocompleteInteraction.d.ts +34 -0
  145. package/dist/src/internals/AutocompleteInteraction.d.ts.map +1 -0
  146. package/dist/src/internals/AutocompleteInteraction.js +68 -0
  147. package/dist/src/internals/AutocompleteInteraction.js.map +1 -0
  148. package/dist/src/internals/ButtonInteraction.d.ts +8 -0
  149. package/dist/src/internals/ButtonInteraction.d.ts.map +1 -0
  150. package/dist/src/internals/ButtonInteraction.js +18 -0
  151. package/dist/src/internals/ButtonInteraction.js.map +1 -0
  152. package/dist/src/internals/ChannelSelectMenuInteraction.d.ts +7 -0
  153. package/dist/src/internals/ChannelSelectMenuInteraction.d.ts.map +1 -0
  154. package/dist/src/internals/ChannelSelectMenuInteraction.js +11 -0
  155. package/dist/src/internals/ChannelSelectMenuInteraction.js.map +1 -0
  156. package/dist/src/internals/CommandHandler.d.ts +8 -0
  157. package/dist/src/internals/CommandHandler.d.ts.map +1 -0
  158. package/dist/src/internals/CommandHandler.js +81 -0
  159. package/dist/src/internals/CommandHandler.js.map +1 -0
  160. package/dist/src/internals/CommandInteraction.d.ts +17 -0
  161. package/dist/src/internals/CommandInteraction.d.ts.map +1 -0
  162. package/dist/src/internals/CommandInteraction.js +29 -0
  163. package/dist/src/internals/CommandInteraction.js.map +1 -0
  164. package/dist/src/internals/ComponentHandler.d.ts +6 -0
  165. package/dist/src/internals/ComponentHandler.d.ts.map +1 -0
  166. package/dist/src/internals/ComponentHandler.js +64 -0
  167. package/dist/src/internals/ComponentHandler.js.map +1 -0
  168. package/dist/src/internals/MentionableSelectMenuInteraction.d.ts +8 -0
  169. package/dist/src/internals/MentionableSelectMenuInteraction.d.ts.map +1 -0
  170. package/dist/src/internals/MentionableSelectMenuInteraction.js +15 -0
  171. package/dist/src/internals/MentionableSelectMenuInteraction.js.map +1 -0
  172. package/dist/src/internals/OptionsHandler.d.ts +70 -0
  173. package/dist/src/internals/OptionsHandler.d.ts.map +1 -0
  174. package/dist/src/internals/OptionsHandler.js +115 -0
  175. package/dist/src/internals/OptionsHandler.js.map +1 -0
  176. package/dist/src/internals/RoleSelectMenuInteraction.d.ts +8 -0
  177. package/dist/src/internals/RoleSelectMenuInteraction.d.ts.map +1 -0
  178. package/dist/src/internals/RoleSelectMenuInteraction.js +14 -0
  179. package/dist/src/internals/RoleSelectMenuInteraction.js.map +1 -0
  180. package/dist/src/internals/StringSelectMenuInteraction.d.ts +8 -0
  181. package/dist/src/internals/StringSelectMenuInteraction.d.ts.map +1 -0
  182. package/dist/src/internals/StringSelectMenuInteraction.js +14 -0
  183. package/dist/src/internals/StringSelectMenuInteraction.js.map +1 -0
  184. package/dist/src/internals/UserSelectMenuInteraction.d.ts +8 -0
  185. package/dist/src/internals/UserSelectMenuInteraction.d.ts.map +1 -0
  186. package/dist/src/internals/UserSelectMenuInteraction.js +14 -0
  187. package/dist/src/internals/UserSelectMenuInteraction.js.map +1 -0
  188. package/dist/src/structures/AnySelectMenu.d.ts +31 -0
  189. package/dist/src/structures/AnySelectMenu.d.ts.map +1 -0
  190. package/dist/src/structures/AnySelectMenu.js +19 -0
  191. package/dist/src/structures/AnySelectMenu.js.map +1 -0
  192. package/dist/src/structures/AnySelectMenuInteraction.d.ts +12 -0
  193. package/dist/src/structures/AnySelectMenuInteraction.d.ts.map +1 -0
  194. package/dist/src/structures/AnySelectMenuInteraction.js +21 -0
  195. package/dist/src/structures/AnySelectMenuInteraction.js.map +1 -0
  196. package/dist/src/structures/Base.d.ts +10 -0
  197. package/dist/src/structures/Base.d.ts.map +1 -0
  198. package/dist/src/structures/Base.js +11 -0
  199. package/dist/src/structures/Base.js.map +1 -0
  200. package/dist/src/structures/BaseCommand.d.ts +64 -0
  201. package/dist/src/structures/BaseCommand.d.ts.map +1 -0
  202. package/dist/src/structures/BaseCommand.js +58 -0
  203. package/dist/src/structures/BaseCommand.js.map +1 -0
  204. package/dist/src/structures/BaseComponent.d.ts +34 -0
  205. package/dist/src/structures/BaseComponent.d.ts.map +1 -0
  206. package/dist/src/structures/BaseComponent.js +30 -0
  207. package/dist/src/structures/BaseComponent.js.map +1 -0
  208. package/dist/src/structures/BaseComponentInteraction.d.ts +9 -0
  209. package/dist/src/structures/BaseComponentInteraction.d.ts.map +1 -0
  210. package/dist/src/structures/BaseComponentInteraction.js +14 -0
  211. package/dist/src/structures/BaseComponentInteraction.js.map +1 -0
  212. package/dist/src/structures/BaseInteraction.d.ts +81 -0
  213. package/dist/src/structures/BaseInteraction.d.ts.map +1 -0
  214. package/dist/src/structures/BaseInteraction.js +99 -0
  215. package/dist/src/structures/BaseInteraction.js.map +1 -0
  216. package/dist/src/structures/ButtonInteraction.d.ts +8 -0
  217. package/dist/src/structures/ButtonInteraction.d.ts.map +1 -0
  218. package/dist/src/structures/ButtonInteraction.js +18 -0
  219. package/dist/src/structures/ButtonInteraction.js.map +1 -0
  220. package/dist/src/structures/ChannelSelectMenuInteraction.d.ts +7 -0
  221. package/dist/src/structures/ChannelSelectMenuInteraction.d.ts.map +1 -0
  222. package/dist/src/structures/ChannelSelectMenuInteraction.js +11 -0
  223. package/dist/src/structures/ChannelSelectMenuInteraction.js.map +1 -0
  224. package/dist/src/structures/CommandHandler.d.ts +6 -0
  225. package/dist/src/structures/CommandHandler.d.ts.map +1 -0
  226. package/dist/src/structures/CommandHandler.js +70 -0
  227. package/dist/src/structures/CommandHandler.js.map +1 -0
  228. package/dist/src/structures/CommandInteraction.d.ts +15 -0
  229. package/dist/src/structures/CommandInteraction.d.ts.map +1 -0
  230. package/dist/src/structures/CommandInteraction.js +60 -0
  231. package/dist/src/structures/CommandInteraction.js.map +1 -0
  232. package/dist/src/structures/ComponentHandler.d.ts +6 -0
  233. package/dist/src/structures/ComponentHandler.d.ts.map +1 -0
  234. package/dist/src/structures/ComponentHandler.js +64 -0
  235. package/dist/src/structures/ComponentHandler.js.map +1 -0
  236. package/dist/src/structures/DmChannel.d.ts +18 -0
  237. package/dist/src/structures/DmChannel.d.ts.map +1 -0
  238. package/dist/src/structures/DmChannel.js +24 -0
  239. package/dist/src/structures/DmChannel.js.map +1 -0
  240. package/dist/src/structures/GroupDmChannel.d.ts +67 -0
  241. package/dist/src/structures/GroupDmChannel.d.ts.map +1 -0
  242. package/dist/src/structures/GroupDmChannel.js +109 -0
  243. package/dist/src/structures/GroupDmChannel.js.map +1 -0
  244. package/dist/src/structures/Guild.d.ts +71 -0
  245. package/dist/src/structures/Guild.d.ts.map +1 -0
  246. package/dist/src/structures/Guild.js +123 -0
  247. package/dist/src/structures/Guild.js.map +1 -0
  248. package/dist/src/structures/GuildAnnouncementChannel.d.ts +12 -0
  249. package/dist/src/structures/GuildAnnouncementChannel.d.ts.map +1 -0
  250. package/dist/src/structures/GuildAnnouncementChannel.js +17 -0
  251. package/dist/src/structures/GuildAnnouncementChannel.js.map +1 -0
  252. package/dist/src/structures/GuildCategoryChannel.d.ts +13 -0
  253. package/dist/src/structures/GuildCategoryChannel.d.ts.map +1 -0
  254. package/dist/src/structures/GuildCategoryChannel.js +14 -0
  255. package/dist/src/structures/GuildCategoryChannel.js.map +1 -0
  256. package/dist/src/structures/GuildForumChannel.d.ts +13 -0
  257. package/dist/src/structures/GuildForumChannel.d.ts.map +1 -0
  258. package/dist/src/structures/GuildForumChannel.js +14 -0
  259. package/dist/src/structures/GuildForumChannel.js.map +1 -0
  260. package/dist/src/structures/GuildMediaChannel.d.ts +13 -0
  261. package/dist/src/structures/GuildMediaChannel.d.ts.map +1 -0
  262. package/dist/src/structures/GuildMediaChannel.js +12 -0
  263. package/dist/src/structures/GuildMediaChannel.js.map +1 -0
  264. package/dist/src/structures/GuildStageOrVoiceChannel.d.ts +30 -0
  265. package/dist/src/structures/GuildStageOrVoiceChannel.d.ts.map +1 -0
  266. package/dist/src/structures/GuildStageOrVoiceChannel.js +34 -0
  267. package/dist/src/structures/GuildStageOrVoiceChannel.js.map +1 -0
  268. package/dist/src/structures/GuildTextChannel.d.ts +15 -0
  269. package/dist/src/structures/GuildTextChannel.d.ts.map +1 -0
  270. package/dist/src/structures/GuildTextChannel.js +18 -0
  271. package/dist/src/structures/GuildTextChannel.js.map +1 -0
  272. package/dist/src/structures/GuildThreadChannel.d.ts +89 -0
  273. package/dist/src/structures/GuildThreadChannel.d.ts.map +1 -0
  274. package/dist/src/structures/GuildThreadChannel.js +134 -0
  275. package/dist/src/structures/GuildThreadChannel.js.map +1 -0
  276. package/dist/src/structures/MentionableSelectMenuInteraction.d.ts +8 -0
  277. package/dist/src/structures/MentionableSelectMenuInteraction.d.ts.map +1 -0
  278. package/dist/src/structures/MentionableSelectMenuInteraction.js +15 -0
  279. package/dist/src/structures/MentionableSelectMenuInteraction.js.map +1 -0
  280. package/dist/src/structures/Message.d.ts +52 -0
  281. package/dist/src/structures/Message.d.ts.map +1 -0
  282. package/dist/src/structures/Message.js +93 -0
  283. package/dist/src/structures/Message.js.map +1 -0
  284. package/dist/src/structures/Role.d.ts +106 -0
  285. package/dist/src/structures/Role.d.ts.map +1 -0
  286. package/dist/src/structures/Role.js +181 -0
  287. package/dist/src/structures/Role.js.map +1 -0
  288. package/dist/src/structures/RoleSelectMenuInteraction.d.ts +8 -0
  289. package/dist/src/structures/RoleSelectMenuInteraction.d.ts.map +1 -0
  290. package/dist/src/structures/RoleSelectMenuInteraction.js +14 -0
  291. package/dist/src/structures/RoleSelectMenuInteraction.js.map +1 -0
  292. package/dist/src/structures/StringSelectMenuInteraction.d.ts +8 -0
  293. package/dist/src/structures/StringSelectMenuInteraction.d.ts.map +1 -0
  294. package/dist/src/structures/StringSelectMenuInteraction.js +14 -0
  295. package/dist/src/structures/StringSelectMenuInteraction.js.map +1 -0
  296. package/dist/src/structures/User.d.ts +80 -0
  297. package/dist/src/structures/User.d.ts.map +1 -0
  298. package/dist/src/structures/User.js +133 -0
  299. package/dist/src/structures/User.js.map +1 -0
  300. package/dist/src/structures/UserSelectMenuInteraction.d.ts +8 -0
  301. package/dist/src/structures/UserSelectMenuInteraction.d.ts.map +1 -0
  302. package/dist/src/structures/UserSelectMenuInteraction.js +14 -0
  303. package/dist/src/structures/UserSelectMenuInteraction.js.map +1 -0
  304. package/dist/src/types.d.ts +31 -0
  305. package/dist/src/types.d.ts.map +1 -0
  306. package/dist/src/types.js +33 -0
  307. package/dist/src/types.js.map +1 -0
  308. package/dist/src/utils.d.ts +2 -0
  309. package/dist/src/utils.d.ts.map +1 -0
  310. package/dist/src/utils.js +11 -0
  311. package/dist/src/utils.js.map +1 -0
  312. package/dist/tsconfig.tsbuildinfo +1 -0
  313. package/docs/classes/AnySelectMenu.mdx +114 -0
  314. package/docs/classes/AnySelectMenuInteraction.mdx +161 -0
  315. package/docs/classes/AutocompleteInteraction.mdx +152 -0
  316. package/docs/classes/AutocompleteOptionsHandler.mdx +243 -0
  317. package/docs/classes/BaseChannel.mdx +97 -0
  318. package/docs/classes/BaseCommand.mdx +61 -0
  319. package/docs/classes/BaseComponent.mdx +55 -0
  320. package/docs/classes/BaseComponentInteraction.mdx +146 -0
  321. package/docs/classes/BaseGuildChannel.mdx +262 -0
  322. package/docs/classes/BaseGuildTextChannel.mdx +360 -0
  323. package/docs/classes/BaseInteraction.mdx +127 -0
  324. package/docs/classes/Button.mdx +99 -0
  325. package/docs/classes/ButtonInteraction.mdx +141 -0
  326. package/docs/classes/ChannelSelectMenu.mdx +122 -0
  327. package/docs/classes/ChannelSelectMenuInteraction.mdx +157 -0
  328. package/docs/classes/Client.mdx +48 -0
  329. package/docs/classes/Command.mdx +111 -0
  330. package/docs/classes/CommandHandler.mdx +65 -0
  331. package/docs/classes/CommandInteraction.mdx +141 -0
  332. package/docs/classes/CommandWithSubcommandGroups.mdx +73 -0
  333. package/docs/classes/CommandWithSubcommands.mdx +76 -0
  334. package/docs/classes/ComponentHandler.mdx +49 -0
  335. package/docs/classes/DmChannel.mdx +118 -0
  336. package/docs/classes/GroupDmChannel.mdx +197 -0
  337. package/docs/classes/Guild.mdx +139 -0
  338. package/docs/classes/GuildAnnouncementChannel.mdx +377 -0
  339. package/docs/classes/GuildCategoryChannel.mdx +272 -0
  340. package/docs/classes/GuildForumChannel.mdx +333 -0
  341. package/docs/classes/GuildMediaChannel.mdx +327 -0
  342. package/docs/classes/GuildStageChannel.mdx +276 -0
  343. package/docs/classes/GuildStageOrVoiceChannel.mdx +292 -0
  344. package/docs/classes/GuildTextChannel.mdx +367 -0
  345. package/docs/classes/GuildThreadChannel.mdx +425 -0
  346. package/docs/classes/GuildThreadOnlyChannel.mdx +333 -0
  347. package/docs/classes/GuildVoiceChannel.mdx +276 -0
  348. package/docs/classes/LinkButton.mdx +84 -0
  349. package/docs/classes/MentionableSelectMenu.mdx +120 -0
  350. package/docs/classes/MentionableSelectMenuInteraction.mdx +157 -0
  351. package/docs/classes/Message.mdx +126 -0
  352. package/docs/classes/OptionsHandler.mdx +203 -0
  353. package/docs/classes/PremiumButton.mdx +84 -0
  354. package/docs/classes/Role.mdx +228 -0
  355. package/docs/classes/RoleSelectMenu.mdx +120 -0
  356. package/docs/classes/RoleSelectMenuInteraction.mdx +157 -0
  357. package/docs/classes/Row.mdx +88 -0
  358. package/docs/classes/StringSelectMenu.mdx +120 -0
  359. package/docs/classes/StringSelectMenuInteraction.mdx +157 -0
  360. package/docs/classes/User.mdx +119 -0
  361. package/docs/classes/UserSelectMenu.mdx +120 -0
  362. package/docs/classes/UserSelectMenuInteraction.mdx +157 -0
  363. package/docs/enumerations/ClientMode.mdx +16 -0
  364. package/docs/functions/channelFactory.mdx +16 -0
  365. package/docs/index.mdx +83 -0
  366. package/docs/type-aliases/AnySelectMenuComponentType.mdx +5 -0
  367. package/docs/type-aliases/ClientOptions.mdx +20 -0
  368. package/docs/type-aliases/CommandOptions.mdx +5 -0
  369. package/docs/type-aliases/ComponentAdditionalData.mdx +9 -0
  370. package/docs/type-aliases/InteractionFileData.mdx +15 -0
  371. package/docs/type-aliases/InteractionReplyData.mdx +14 -0
  372. package/docs/type-aliases/InteractionReplyOptions.mdx +13 -0
  373. package/docs/type-aliases/RawOptions.mdx +9 -0
  374. package/docs/type-aliases/meta.json +3 -0
  375. package/package.json +18 -0
  376. package/src/README.md +7 -0
  377. package/src/abstracts/AnySelectMenu.ts +63 -0
  378. package/src/abstracts/AnySelectMenuInteraction.ts +29 -0
  379. package/src/abstracts/Base.ts +12 -0
  380. package/src/abstracts/BaseChannel.ts +73 -0
  381. package/src/abstracts/BaseCommand.ts +95 -0
  382. package/src/abstracts/BaseComponent.ts +49 -0
  383. package/src/abstracts/BaseComponentInteraction.ts +19 -0
  384. package/src/abstracts/BaseGuildChannel.ts +152 -0
  385. package/src/abstracts/BaseGuildTextChannel.ts +77 -0
  386. package/src/abstracts/BaseInteraction.ts +170 -0
  387. package/src/abstracts/GuildThreadOnlyChannel.ts +71 -0
  388. package/src/classes/Button.ts +95 -0
  389. package/src/classes/ChannelSelectMenu.ts +21 -0
  390. package/src/classes/Client.ts +249 -0
  391. package/src/classes/Command.ts +51 -0
  392. package/src/classes/CommandWithSubcommandGroups.ts +47 -0
  393. package/src/classes/CommandWithSubcommands.ts +35 -0
  394. package/src/classes/MentionableSelectMenu.ts +19 -0
  395. package/src/classes/RoleSelectMenu.ts +19 -0
  396. package/src/classes/Row.ts +44 -0
  397. package/src/classes/StringSelectMenu.ts +19 -0
  398. package/src/classes/UserSelectMenu.ts +19 -0
  399. package/src/factories/channelFactory.ts +43 -0
  400. package/src/index.ts +59 -0
  401. package/src/internals/AutocompleteInteraction.ts +107 -0
  402. package/src/internals/ButtonInteraction.ts +26 -0
  403. package/src/internals/ChannelSelectMenuInteraction.ts +15 -0
  404. package/src/internals/CommandHandler.ts +123 -0
  405. package/src/internals/CommandInteraction.ts +49 -0
  406. package/src/internals/ComponentHandler.ts +81 -0
  407. package/src/internals/MentionableSelectMenuInteraction.ts +21 -0
  408. package/src/internals/OptionsHandler.ts +147 -0
  409. package/src/internals/RoleSelectMenuInteraction.ts +20 -0
  410. package/src/internals/StringSelectMenuInteraction.ts +20 -0
  411. package/src/internals/UserSelectMenuInteraction.ts +20 -0
  412. package/src/structures/DmChannel.ts +31 -0
  413. package/src/structures/GroupDmChannel.ts +132 -0
  414. package/src/structures/Guild.ts +142 -0
  415. package/src/structures/GuildAnnouncementChannel.ts +20 -0
  416. package/src/structures/GuildCategoryChannel.ts +16 -0
  417. package/src/structures/GuildForumChannel.ts +20 -0
  418. package/src/structures/GuildMediaChannel.ts +13 -0
  419. package/src/structures/GuildStageOrVoiceChannel.ts +46 -0
  420. package/src/structures/GuildTextChannel.ts +21 -0
  421. package/src/structures/GuildThreadChannel.ts +150 -0
  422. package/src/structures/Message.ts +124 -0
  423. package/src/structures/Role.ts +201 -0
  424. package/src/structures/User.ts +153 -0
  425. package/src/utils.ts +13 -0
  426. package/tests/index.test.ts +4 -0
  427. package/tsconfig.json +12 -0
  428. package/typedoc.json +9 -0
@@ -0,0 +1,152 @@
1
+ ---
2
+ title: AutocompleteInteraction
3
+ ---
4
+
5
+ This is the base type interaction, all interaction types extend from this
6
+
7
+ ## Extends
8
+
9
+ - [`BaseInteraction`](/carbon/api/classes/BaseInteraction)\<`APIApplicationCommandAutocompleteInteraction`\>
10
+
11
+ ## Constructors
12
+
13
+ ### new AutocompleteInteraction()
14
+
15
+ > **new AutocompleteInteraction**(`client`, `data`, `command`?): [`AutocompleteInteraction`](/carbon/api/classes/AutocompleteInteraction)
16
+
17
+ #### Parameters
18
+
19
+ | Parameter | Type |
20
+ | ------ | ------ |
21
+ | `client` | [`Client`](/carbon/api/classes/Client) |
22
+ | `data` | `APIApplicationCommandAutocompleteInteraction` |
23
+ | `command`? | [`BaseCommand`](/carbon/api/classes/BaseCommand) |
24
+
25
+ #### Returns
26
+
27
+ [`AutocompleteInteraction`](/carbon/api/classes/AutocompleteInteraction)
28
+
29
+ #### Overrides
30
+
31
+ [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`constructor`](/carbon/api/classes/BaseInteraction#constructors)
32
+
33
+ ## Properties
34
+
35
+ | Property | Type | Default value | Description | Inherited from |
36
+ | ------ | ------ | ------ | ------ | ------ |
37
+ | `_deferred` | `boolean` | `false` | **`Internal`** Whether the interaction is deferred already | [`BaseInteraction`](/carbon/api/classes/BaseInteraction).`_deferred` |
38
+ | `client` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`BaseInteraction`](/carbon/api/classes/BaseInteraction).`client` |
39
+ | `options?` | [`AutocompleteOptionsHandler`](/carbon/api/classes/AutocompleteOptionsHandler) | `undefined` | This is the options of the commands, parsed from the interaction data. | - |
40
+ | `rawData` | `APIApplicationCommandAutocompleteInteraction` | `undefined` | The raw data of the interaction | [`BaseInteraction`](/carbon/api/classes/BaseInteraction).`rawData` |
41
+ | `type` | `InteractionType` | `undefined` | The type of interaction | [`BaseInteraction`](/carbon/api/classes/BaseInteraction).`type` |
42
+ | `userId` | `undefined` \| `string` | `undefined` | The user who sent the interaction | [`BaseInteraction`](/carbon/api/classes/BaseInteraction).`userId` |
43
+
44
+ ## Accessors
45
+
46
+ ### channel
47
+
48
+ > `get` **channel**(): `null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)
49
+
50
+ #### Returns
51
+
52
+ `null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)
53
+
54
+ #### Inherited from
55
+
56
+ [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`channel`](/carbon/api/classes/BaseInteraction#channel)
57
+
58
+ ***
59
+
60
+ ### guild
61
+
62
+ > `get` **guild**(): `null` \| [`Guild`](/carbon/api/classes/Guild)
63
+
64
+ #### Returns
65
+
66
+ `null` \| [`Guild`](/carbon/api/classes/Guild)
67
+
68
+ #### Inherited from
69
+
70
+ [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`guild`](/carbon/api/classes/BaseInteraction#guild)
71
+
72
+ ***
73
+
74
+ ### message
75
+
76
+ > `get` **message**(): `null` \| [`Message`](/carbon/api/classes/Message)
77
+
78
+ #### Returns
79
+
80
+ `null` \| [`Message`](/carbon/api/classes/Message)
81
+
82
+ #### Inherited from
83
+
84
+ [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`message`](/carbon/api/classes/BaseInteraction#message)
85
+
86
+ ***
87
+
88
+ ### user
89
+
90
+ > `get` **user**(): `null` \| [`User`](/carbon/api/classes/User)
91
+
92
+ #### Returns
93
+
94
+ `null` \| [`User`](/carbon/api/classes/User)
95
+
96
+ #### Inherited from
97
+
98
+ [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`user`](/carbon/api/classes/BaseInteraction#user)
99
+
100
+ ## Methods
101
+
102
+ ### defer()
103
+
104
+ > **defer**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
105
+
106
+ **`Internal`**
107
+
108
+ Defer the interaction response. This is used automatically by commands that are set to defer.
109
+ If the interaction is already deferred, this will do nothing.
110
+
111
+ #### Returns
112
+
113
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
114
+
115
+ #### Overrides
116
+
117
+ [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`defer`](/carbon/api/classes/BaseInteraction#defer)
118
+
119
+ ***
120
+
121
+ ### reply()
122
+
123
+ > **reply**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
124
+
125
+ Reply to an interaction.
126
+ If the interaction is deferred, this will edit the original response.
127
+
128
+ #### Returns
129
+
130
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
131
+
132
+ #### Overrides
133
+
134
+ [`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`reply`](/carbon/api/classes/BaseInteraction#reply)
135
+
136
+ ***
137
+
138
+ ### respond()
139
+
140
+ > **respond**(`choices`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
141
+
142
+ Respond with the choices for an autocomplete interaction
143
+
144
+ #### Parameters
145
+
146
+ | Parameter | Type |
147
+ | ------ | ------ |
148
+ | `choices` | `object`[] |
149
+
150
+ #### Returns
151
+
152
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
@@ -0,0 +1,243 @@
1
+ ---
2
+ title: AutocompleteOptionsHandler
3
+ ---
4
+
5
+ This class is used to parse the options of a command, and provide errors for any missing or invalid options.
6
+ It is used internally by the Command class.
7
+
8
+ ## Extends
9
+
10
+ - [`OptionsHandler`](/carbon/api/classes/OptionsHandler)
11
+
12
+ ## Constructors
13
+
14
+ ### new AutocompleteOptionsHandler()
15
+
16
+ > **new AutocompleteOptionsHandler**(`client`, `options`): [`AutocompleteOptionsHandler`](/carbon/api/classes/AutocompleteOptionsHandler)
17
+
18
+ #### Parameters
19
+
20
+ | Parameter | Type |
21
+ | ------ | ------ |
22
+ | `client` | [`Client`](/carbon/api/classes/Client) |
23
+ | `options` | `APIApplicationCommandInteractionDataBasicOption`[] |
24
+
25
+ #### Returns
26
+
27
+ [`AutocompleteOptionsHandler`](/carbon/api/classes/AutocompleteOptionsHandler)
28
+
29
+ #### Inherited from
30
+
31
+ [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`constructor`](/carbon/api/classes/OptionsHandler#constructors)
32
+
33
+ ## Properties
34
+
35
+ | Property | Modifier | Type | Default value | Description | Inherited from |
36
+ | ------ | ------ | ------ | ------ | ------ | ------ |
37
+ | `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`OptionsHandler`](/carbon/api/classes/OptionsHandler).`client` |
38
+ | `errors` | `readonly` | `string`[] | `[]` | The errors that were encountered while parsing the options. | [`OptionsHandler`](/carbon/api/classes/OptionsHandler).`errors` |
39
+ | `raw` | `readonly` | `APIApplicationCommandInteractionDataBasicOption`[] | `undefined` | The raw options that were in the interaction data, before they were parsed. | [`OptionsHandler`](/carbon/api/classes/OptionsHandler).`raw` |
40
+
41
+ ## Methods
42
+
43
+ ### getBoolean()
44
+
45
+ > **getBoolean**(`key`): `undefined` \| `true`
46
+
47
+ Get the value of a boolean option.
48
+
49
+ #### Parameters
50
+
51
+ | Parameter | Type | Description |
52
+ | ------ | ------ | ------ |
53
+ | `key` | `string` | The name of the option to get the value of. |
54
+
55
+ #### Returns
56
+
57
+ `undefined` \| `true`
58
+
59
+ The value of the option, or undefined if the option was not provided.
60
+
61
+ #### Inherited from
62
+
63
+ [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getBoolean`](/carbon/api/classes/OptionsHandler#getboolean)
64
+
65
+ ***
66
+
67
+ ### getChannel()
68
+
69
+ > **getChannel**(`key`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| `null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)\>
70
+
71
+ Get the value of a channel option.
72
+
73
+ #### Parameters
74
+
75
+ | Parameter | Type | Description |
76
+ | ------ | ------ | ------ |
77
+ | `key` | `string` | The name of the option to get the value of. |
78
+
79
+ #### Returns
80
+
81
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| `null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)\>
82
+
83
+ The value of the option, or undefined if the option was not provided.
84
+
85
+ #### Inherited from
86
+
87
+ [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getChannel`](/carbon/api/classes/OptionsHandler#getchannel)
88
+
89
+ ***
90
+
91
+ ### getFocused()
92
+
93
+ > **getFocused**(): `undefined` \| `null` \| `string` \| `number` \| `true`
94
+
95
+ Get the focused option (the one that is being autocompleted)
96
+
97
+ #### Returns
98
+
99
+ `undefined` \| `null` \| `string` \| `number` \| `true`
100
+
101
+ ***
102
+
103
+ ### getInteger()
104
+
105
+ > **getInteger**(`key`): `undefined` \| `string` \| `number` \| `true`
106
+
107
+ Get the value of an integer option.
108
+
109
+ #### Parameters
110
+
111
+ | Parameter | Type | Description |
112
+ | ------ | ------ | ------ |
113
+ | `key` | `string` | The name of the option to get the value of. |
114
+
115
+ #### Returns
116
+
117
+ `undefined` \| `string` \| `number` \| `true`
118
+
119
+ The value of the option, or undefined if the option was not provided.
120
+
121
+ #### Inherited from
122
+
123
+ [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getInteger`](/carbon/api/classes/OptionsHandler#getinteger)
124
+
125
+ ***
126
+
127
+ ### getMentionable()
128
+
129
+ > **getMentionable**(`key`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| [`Role`](/carbon/api/classes/Role) \| [`User`](/carbon/api/classes/User)\>
130
+
131
+ Get the value of a mentionable option.
132
+
133
+ #### Parameters
134
+
135
+ | Parameter | Type | Description |
136
+ | ------ | ------ | ------ |
137
+ | `key` | `string` | The name of the option to get the value of. |
138
+
139
+ #### Returns
140
+
141
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| [`Role`](/carbon/api/classes/Role) \| [`User`](/carbon/api/classes/User)\>
142
+
143
+ The value of the option, or undefined if the option was not provided.
144
+
145
+ #### Inherited from
146
+
147
+ [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getMentionable`](/carbon/api/classes/OptionsHandler#getmentionable)
148
+
149
+ ***
150
+
151
+ ### getNumber()
152
+
153
+ > **getNumber**(`key`): `undefined` \| `number`
154
+
155
+ Get the value of a number option.
156
+
157
+ #### Parameters
158
+
159
+ | Parameter | Type | Description |
160
+ | ------ | ------ | ------ |
161
+ | `key` | `string` | The name of the option to get the value of. |
162
+
163
+ #### Returns
164
+
165
+ `undefined` \| `number`
166
+
167
+ The value of the option, or undefined if the option was not provided.
168
+
169
+ #### Inherited from
170
+
171
+ [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getNumber`](/carbon/api/classes/OptionsHandler#getnumber)
172
+
173
+ ***
174
+
175
+ ### getRole()
176
+
177
+ > **getRole**(`key`): `undefined` \| [`Role`](/carbon/api/classes/Role)
178
+
179
+ Get the value of a role option.
180
+
181
+ #### Parameters
182
+
183
+ | Parameter | Type | Description |
184
+ | ------ | ------ | ------ |
185
+ | `key` | `string` | The name of the option to get the value of. |
186
+
187
+ #### Returns
188
+
189
+ `undefined` \| [`Role`](/carbon/api/classes/Role)
190
+
191
+ The value of the option, or undefined if the option was not provided.
192
+
193
+ #### Inherited from
194
+
195
+ [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getRole`](/carbon/api/classes/OptionsHandler#getrole)
196
+
197
+ ***
198
+
199
+ ### getString()
200
+
201
+ > **getString**(`key`): `undefined` \| `string`
202
+
203
+ Get the value of a string option.
204
+
205
+ #### Parameters
206
+
207
+ | Parameter | Type | Description |
208
+ | ------ | ------ | ------ |
209
+ | `key` | `string` | The name of the option to get the value of. |
210
+
211
+ #### Returns
212
+
213
+ `undefined` \| `string`
214
+
215
+ The value of the option, or undefined if the option was not provided.
216
+
217
+ #### Inherited from
218
+
219
+ [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getString`](/carbon/api/classes/OptionsHandler#getstring)
220
+
221
+ ***
222
+
223
+ ### getUser()
224
+
225
+ > **getUser**(`key`): `undefined` \| [`User`](/carbon/api/classes/User)
226
+
227
+ Get the value of a user option.
228
+
229
+ #### Parameters
230
+
231
+ | Parameter | Type | Description |
232
+ | ------ | ------ | ------ |
233
+ | `key` | `string` | The name of the option to get the value of. |
234
+
235
+ #### Returns
236
+
237
+ `undefined` \| [`User`](/carbon/api/classes/User)
238
+
239
+ The value of the option, or undefined if the option was not provided.
240
+
241
+ #### Inherited from
242
+
243
+ [`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getUser`](/carbon/api/classes/OptionsHandler#getuser)
@@ -0,0 +1,97 @@
1
+ ---
2
+ title: BaseChannel
3
+ ---
4
+
5
+ ## Extends
6
+
7
+ - `Base`
8
+
9
+ ## Extended by
10
+
11
+ - [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel)
12
+ - [`DmChannel`](/carbon/api/classes/DmChannel)
13
+ - [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel)
14
+
15
+ ## Type Parameters
16
+
17
+ | Type Parameter |
18
+ | ------ |
19
+ | `Type` *extends* `ChannelType` |
20
+
21
+ ## Constructors
22
+
23
+ ### new BaseChannel()
24
+
25
+ > **new BaseChannel**\<`Type`\>(`client`, `rawDataOrId`): [`BaseChannel`](/carbon/api/classes/BaseChannel)\<`Type`\>
26
+
27
+ #### Parameters
28
+
29
+ | Parameter | Type |
30
+ | ------ | ------ |
31
+ | `client` | [`Client`](/carbon/api/classes/Client) |
32
+ | `rawDataOrId` | `string` \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGroupDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildCategoryChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildForumChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildMediaChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildStageVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APINewsChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APITextChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIThreadChannel`, `object`\> |
33
+
34
+ #### Returns
35
+
36
+ [`BaseChannel`](/carbon/api/classes/BaseChannel)\<`Type`\>
37
+
38
+ #### Overrides
39
+
40
+ `Base.constructor`
41
+
42
+ ## Properties
43
+
44
+ | Property | Modifier | Type | Default value | Description | Inherited from |
45
+ | ------ | ------ | ------ | ------ | ------ | ------ |
46
+ | `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | `Base.client` |
47
+ | `flags?` | `public` | `null` \| `number` | `undefined` | The flags of the channel in a bitfield. **See** https://discord.com/developers/docs/resources/channel#channel-object-channel-flags | - |
48
+ | `id` | `public` | `string` | `undefined` | The id of the channel. | - |
49
+ | `partial` | `public` | `boolean` | `undefined` | Whether the channel is a partial channel (meaning it does not have all the data). If this is true, you should use [BaseChannel.fetch](/carbon/api/classes/BaseChannel#fetch) to get the full data of the channel. | - |
50
+ | `rawData` | `protected` | `null` \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGroupDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildCategoryChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildForumChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildMediaChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildStageVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APINewsChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APITextChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIThreadChannel`, `object`\> | `null` | The raw data of the channel. | - |
51
+ | `type?` | `public` | `Type` | `undefined` | The type of the channel. | - |
52
+
53
+ ## Methods
54
+
55
+ ### fetch()
56
+
57
+ > **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
58
+
59
+ Fetches the channel from the API.
60
+
61
+ #### Returns
62
+
63
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
64
+
65
+ The channel data.
66
+
67
+ ***
68
+
69
+ ### setData()
70
+
71
+ > `protected` **setData**(`data`): `void`
72
+
73
+ #### Parameters
74
+
75
+ | Parameter | Type |
76
+ | ------ | ------ |
77
+ | `data` | [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGroupDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildCategoryChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildForumChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildMediaChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildStageVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APINewsChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APITextChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIThreadChannel`, `object`\> |
78
+
79
+ #### Returns
80
+
81
+ `void`
82
+
83
+ ***
84
+
85
+ ### setSpecificData()
86
+
87
+ > `abstract` `protected` **setSpecificData**(`data`): `void`
88
+
89
+ #### Parameters
90
+
91
+ | Parameter | Type |
92
+ | ------ | ------ |
93
+ | `data` | [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGroupDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildCategoryChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildForumChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildMediaChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildStageVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APINewsChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APITextChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIThreadChannel`, `object`\> |
94
+
95
+ #### Returns
96
+
97
+ `void`
@@ -0,0 +1,61 @@
1
+ ---
2
+ title: BaseCommand
3
+ ---
4
+
5
+ Represents the base data of a command that the user creates
6
+
7
+ ## Extended by
8
+
9
+ - [`Command`](/carbon/api/classes/Command)
10
+ - [`CommandWithSubcommands`](/carbon/api/classes/CommandWithSubcommands)
11
+
12
+ ## Constructors
13
+
14
+ ### new BaseCommand()
15
+
16
+ > **new BaseCommand**(): [`BaseCommand`](/carbon/api/classes/BaseCommand)
17
+
18
+ #### Returns
19
+
20
+ [`BaseCommand`](/carbon/api/classes/BaseCommand)
21
+
22
+ ## Properties
23
+
24
+ | Property | Modifier | Type | Default value | Description |
25
+ | ------ | ------ | ------ | ------ | ------ |
26
+ | `components?` | `public` | [`BaseComponent`](/carbon/api/classes/BaseComponent)[] | `[]` | All the components that the command is able to use. You mount these here so the handler can access them |
27
+ | `contexts` | `public` | `InteractionContextType`[] | `undefined` | **`Beta`** The contexts this command can be used in API types are not finalized |
28
+ | `defer` | `public` | `boolean` | `false` | Whether the command response should be automatically deferred |
29
+ | `description` | `abstract` | `string` | `undefined` | A description of the command |
30
+ | `ephemeral` | `public` | `boolean` | `false` | Whether the command response should be ephemeral |
31
+ | `integrationTypes` | `public` | `ApplicationIntegrationType`[] | `undefined` | **`Beta`** The places this command can be used in API types are not finalized |
32
+ | `name` | `abstract` | `string` | `undefined` | The name of the command (e.g. "ping" for /ping) |
33
+ | `type` | `abstract` | `ApplicationCommandType` | `undefined` | The type of the command |
34
+
35
+ ## Methods
36
+
37
+ ### serialize()
38
+
39
+ > **serialize**(): `RESTPostAPIChatInputApplicationCommandsJSONBody` \| `RESTPostAPIContextMenuApplicationCommandsJSONBody`
40
+
41
+ **`Internal`**
42
+
43
+ Serializes the command into a JSON object that can be sent to Discord
44
+
45
+ #### Returns
46
+
47
+ `RESTPostAPIChatInputApplicationCommandsJSONBody` \| `RESTPostAPIContextMenuApplicationCommandsJSONBody`
48
+
49
+ ***
50
+
51
+ ### serializeOptions()
52
+
53
+ > `abstract` **serializeOptions**(): `AddUndefinedToPossiblyUndefinedPropertiesOfInterface`\<`undefined` \| `APIApplicationCommandOption`[]\>
54
+
55
+ **`Internal`**
56
+
57
+ Serializes the options of the command into a JSON object that can be sent to Discord
58
+
59
+ #### Returns
60
+
61
+ `AddUndefinedToPossiblyUndefinedPropertiesOfInterface`\<`undefined` \| `APIApplicationCommandOption`[]\>
@@ -0,0 +1,55 @@
1
+ ---
2
+ title: BaseComponent
3
+ ---
4
+
5
+ ## Extended by
6
+
7
+ - [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu)
8
+
9
+ ## Constructors
10
+
11
+ ### new BaseComponent()
12
+
13
+ > **new BaseComponent**(`data`?): [`BaseComponent`](/carbon/api/classes/BaseComponent)
14
+
15
+ #### Parameters
16
+
17
+ | Parameter | Type |
18
+ | ------ | ------ |
19
+ | `data`? | `object` |
20
+ | `data.additionalData`? | [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) |
21
+
22
+ #### Returns
23
+
24
+ [`BaseComponent`](/carbon/api/classes/BaseComponent)
25
+
26
+ ## Properties
27
+
28
+ | Property | Modifier | Type | Default value | Description |
29
+ | ------ | ------ | ------ | ------ | ------ |
30
+ | `additionalData` | `public` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | `null` | - |
31
+ | `customId` | `abstract` | `string` | `undefined` | The custom ID of the component |
32
+ | `defer` | `public` | `boolean` | `false` | Whether the component response should be automatically deferred |
33
+ | `ephemeral` | `public` | `boolean` | `false` | Whether the component response should be ephemeral |
34
+ | `serialize` | `abstract` | () => `APIBaseComponent`\<`ComponentType`\> | `undefined` | - |
35
+ | `type` | `abstract` | `ComponentType` | `undefined` | The type of the component |
36
+
37
+ ## Methods
38
+
39
+ ### createId()
40
+
41
+ > **createId**(`additionalData`): `string`
42
+
43
+ Create a custom ID to use for this component that embeds additional data that you want to be handed
44
+
45
+ #### Parameters
46
+
47
+ | Parameter | Type | Description |
48
+ | ------ | ------ | ------ |
49
+ | `additionalData` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | The additional data that you want to be passed in this component's custom ID |
50
+
51
+ #### Returns
52
+
53
+ `string`
54
+
55
+ The custom ID to use