@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,327 @@
1
+ ---
2
+ title: GuildMediaChannel
3
+ ---
4
+
5
+ Represents a guild media channel (a forum channel )
6
+
7
+ ## Extends
8
+
9
+ - [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel)\<`ChannelType.GuildMedia`\>
10
+
11
+ ## Constructors
12
+
13
+ ### new GuildMediaChannel()
14
+
15
+ > **new GuildMediaChannel**(`client`, `rawDataOrId`): [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)
16
+
17
+ #### Parameters
18
+
19
+ | Parameter | Type |
20
+ | ------ | ------ |
21
+ | `client` | [`Client`](/carbon/api/classes/Client) |
22
+ | `rawDataOrId` | `string` \| `APIGuildMediaChannel` |
23
+
24
+ #### Returns
25
+
26
+ [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)
27
+
28
+ #### Inherited from
29
+
30
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`constructor`](/carbon/api/classes/GuildThreadOnlyChannel#constructors)
31
+
32
+ ## Properties
33
+
34
+ | Property | Modifier | Type | Default value | Description | Inherited from |
35
+ | ------ | ------ | ------ | ------ | ------ | ------ |
36
+ | `availableTags?` | `public` | `APIGuildForumTag`[] | `undefined` | The available tags to set on posts in the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`availableTags` |
37
+ | `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`client` |
38
+ | `defaultAutoArchiveDuration?` | `public` | `null` \| `number` | `undefined` | The default auto archive duration of the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`defaultAutoArchiveDuration` |
39
+ | `defaultForumLayout?` | `public` | `ForumLayoutType` | `undefined` | The default forum layout of the channel. | - |
40
+ | `defaultReactionEmoji?` | `public` | `null` \| `APIGuildForumDefaultReactionEmoji` | `undefined` | The default reaction emoji for the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`defaultReactionEmoji` |
41
+ | `defaultSortOrder?` | `public` | `null` \| `SortOrderType` | `undefined` | The default sort order for the channel, by latest activity or by creation date. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`defaultSortOrder` |
42
+ | `defaultThreadRateLimitPerUser?` | `public` | `null` \| `number` | `undefined` | The default thread rate limit per user for the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`defaultThreadRateLimitPerUser` |
43
+ | `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 | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`flags` |
44
+ | `guildId?` | `public` | `string` | `undefined` | The ID of the guild this channel is in | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`guildId` |
45
+ | `id` | `public` | `string` | `undefined` | The id of the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`id` |
46
+ | `name?` | `public` | `string` | `undefined` | The name of the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`name` |
47
+ | `nsfw?` | `public` | `boolean` | `undefined` | Whether the channel is marked as nsfw. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`nsfw` |
48
+ | `parentId?` | `public` | `null` \| `string` | `undefined` | The ID of the parent category for the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`parentId` |
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. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`partial` |
50
+ | `position?` | `public` | `number` | `undefined` | The position of the channel in the channel list. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`position` |
51
+ | `rawData` | `protected` | `null` \| `APIGuildMediaChannel` | `null` | The raw data of the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`rawData` |
52
+ | `topic?` | `public` | `null` \| `string` | `undefined` | The topic of the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`topic` |
53
+ | `type?` | `public` | `GuildMedia` | `undefined` | The type of the channel. | [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).`type` |
54
+
55
+ ## Accessors
56
+
57
+ ### guild
58
+
59
+ > `get` **guild**(): [`Guild`](/carbon/api/classes/Guild)
60
+
61
+ The guild this channel is in
62
+
63
+ #### Returns
64
+
65
+ [`Guild`](/carbon/api/classes/Guild)
66
+
67
+ #### Inherited from
68
+
69
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`guild`](/carbon/api/classes/GuildThreadOnlyChannel#guild)
70
+
71
+ ## Methods
72
+
73
+ ### createInvite()
74
+
75
+ > **createInvite**(`options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
76
+
77
+ Create an invite for the channel
78
+
79
+ #### Parameters
80
+
81
+ | Parameter | Type |
82
+ | ------ | ------ |
83
+ | `options`? | `RESTPostAPIChannelInviteJSONBody` |
84
+
85
+ #### Returns
86
+
87
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
88
+
89
+ #### Inherited from
90
+
91
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`createInvite`](/carbon/api/classes/GuildThreadOnlyChannel#createinvite)
92
+
93
+ ***
94
+
95
+ ### fetch()
96
+
97
+ > **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
98
+
99
+ Fetches the channel from the API.
100
+
101
+ #### Returns
102
+
103
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
104
+
105
+ The channel data.
106
+
107
+ #### Inherited from
108
+
109
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`fetch`](/carbon/api/classes/GuildThreadOnlyChannel#fetch)
110
+
111
+ ***
112
+
113
+ ### getInvites()
114
+
115
+ > **getInvites**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
116
+
117
+ Get the invites for the channel
118
+
119
+ #### Returns
120
+
121
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
122
+
123
+ #### Inherited from
124
+
125
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`getInvites`](/carbon/api/classes/GuildThreadOnlyChannel#getinvites)
126
+
127
+ ***
128
+
129
+ ### send()
130
+
131
+ > **send**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
132
+
133
+ You cannot send a message directly to a forum or media channel, so this method throws an error.
134
+ Use [GuildThreadChannel.send](/carbon/api/classes/GuildThreadChannel#send) instead, or the alias [GuildThreadOnlyChannel.sendToPost](/carbon/api/classes/GuildThreadOnlyChannel#sendtopost) instead, to send a message to the channel's posts.
135
+
136
+ #### Returns
137
+
138
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
139
+
140
+ #### Inherited from
141
+
142
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`send`](/carbon/api/classes/GuildThreadOnlyChannel#send)
143
+
144
+ ***
145
+
146
+ ### sendToPost()
147
+
148
+ > **sendToPost**(`message`, `postId`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
149
+
150
+ Send a message to a post in the channel
151
+
152
+ #### Parameters
153
+
154
+ | Parameter | Type |
155
+ | ------ | ------ |
156
+ | `message` | `APIMessage` |
157
+ | `postId` | `string` |
158
+
159
+ #### Returns
160
+
161
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
162
+
163
+ #### Remarks
164
+
165
+ This is an alias for [GuildThreadChannel.send](/carbon/api/classes/GuildThreadChannel#send) that will fetch the channel, but if you already have the channel, you can use [GuildThreadChannel.send](/carbon/api/classes/GuildThreadChannel#send) instead.
166
+
167
+ #### Inherited from
168
+
169
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`sendToPost`](/carbon/api/classes/GuildThreadOnlyChannel#sendtopost)
170
+
171
+ ***
172
+
173
+ ### setData()
174
+
175
+ > `protected` **setData**(`data`): `void`
176
+
177
+ #### Parameters
178
+
179
+ | Parameter | Type |
180
+ | ------ | ------ |
181
+ | `data` | `APIGuildChannel`\<`GuildMedia`\> |
182
+
183
+ #### Returns
184
+
185
+ `void`
186
+
187
+ #### Inherited from
188
+
189
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setData`](/carbon/api/classes/GuildThreadOnlyChannel#setdata)
190
+
191
+ ***
192
+
193
+ ### setMoreSpecificData()
194
+
195
+ > `protected` **setMoreSpecificData**(): `void`
196
+
197
+ #### Returns
198
+
199
+ `void`
200
+
201
+ #### Overrides
202
+
203
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setMoreSpecificData`](/carbon/api/classes/GuildThreadOnlyChannel#setmorespecificdata)
204
+
205
+ ***
206
+
207
+ ### setName()
208
+
209
+ > **setName**(`name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
210
+
211
+ Set the name of the channel
212
+
213
+ #### Parameters
214
+
215
+ | Parameter | Type | Description |
216
+ | ------ | ------ | ------ |
217
+ | `name` | `string` | The new name of the channel |
218
+
219
+ #### Returns
220
+
221
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
222
+
223
+ #### Inherited from
224
+
225
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setName`](/carbon/api/classes/GuildThreadOnlyChannel#setname)
226
+
227
+ ***
228
+
229
+ ### setNsfw()
230
+
231
+ > **setNsfw**(`nsfw`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
232
+
233
+ Set whether the channel is nsfw
234
+
235
+ #### Parameters
236
+
237
+ | Parameter | Type | Description |
238
+ | ------ | ------ | ------ |
239
+ | `nsfw` | `boolean` | The new nsfw status of the channel |
240
+
241
+ #### Returns
242
+
243
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
244
+
245
+ #### Inherited from
246
+
247
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setNsfw`](/carbon/api/classes/GuildThreadOnlyChannel#setnsfw)
248
+
249
+ ***
250
+
251
+ ### setParent()
252
+
253
+ > **setParent**(`parent`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
254
+
255
+ Set the parent ID of the channel
256
+
257
+ #### Parameters
258
+
259
+ | Parameter | Type | Description |
260
+ | ------ | ------ | ------ |
261
+ | `parent` | `string` \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) | The new category channel or ID to set |
262
+
263
+ #### Returns
264
+
265
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
266
+
267
+ #### Inherited from
268
+
269
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setParent`](/carbon/api/classes/GuildThreadOnlyChannel#setparent)
270
+
271
+ ***
272
+
273
+ ### setPosition()
274
+
275
+ > **setPosition**(`position`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
276
+
277
+ Set the position of the channel
278
+
279
+ #### Parameters
280
+
281
+ | Parameter | Type | Description |
282
+ | ------ | ------ | ------ |
283
+ | `position` | `number` | The new position of the channel |
284
+
285
+ #### Returns
286
+
287
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
288
+
289
+ #### Inherited from
290
+
291
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setPosition`](/carbon/api/classes/GuildThreadOnlyChannel#setposition)
292
+
293
+ ***
294
+
295
+ ### setSpecificData()
296
+
297
+ > `protected` **setSpecificData**(`data`): `void`
298
+
299
+ #### Parameters
300
+
301
+ | Parameter | Type |
302
+ | ------ | ------ |
303
+ | `data` | `APIThreadOnlyChannel`\<`GuildMedia`\> |
304
+
305
+ #### Returns
306
+
307
+ `void`
308
+
309
+ #### Inherited from
310
+
311
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`setSpecificData`](/carbon/api/classes/GuildThreadOnlyChannel#setspecificdata)
312
+
313
+ ***
314
+
315
+ ### triggerTyping()
316
+
317
+ > **triggerTyping**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
318
+
319
+ Trigger a typing indicator in the channel (this will expire after 10 seconds)
320
+
321
+ #### Returns
322
+
323
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
324
+
325
+ #### Inherited from
326
+
327
+ [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel).[`triggerTyping`](/carbon/api/classes/GuildThreadOnlyChannel#triggertyping)
@@ -0,0 +1,276 @@
1
+ ---
2
+ title: GuildStageChannel
3
+ ---
4
+
5
+ ## Extends
6
+
7
+ - [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel)\<`ChannelType.GuildStageVoice`\>
8
+
9
+ ## Constructors
10
+
11
+ ### new GuildStageChannel()
12
+
13
+ > **new GuildStageChannel**(`client`, `rawDataOrId`): [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel)
14
+
15
+ #### Parameters
16
+
17
+ | Parameter | Type |
18
+ | ------ | ------ |
19
+ | `client` | [`Client`](/carbon/api/classes/Client) |
20
+ | `rawDataOrId` | `string` \| `APIGuildStageVoiceChannel` |
21
+
22
+ #### Returns
23
+
24
+ [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel)
25
+
26
+ #### Inherited from
27
+
28
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`constructor`](/carbon/api/classes/BaseGuildChannel#constructors)
29
+
30
+ ## Properties
31
+
32
+ | Property | Modifier | Type | Default value | Description | Inherited from |
33
+ | ------ | ------ | ------ | ------ | ------ | ------ |
34
+ | `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`client` |
35
+ | `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 | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`flags` |
36
+ | `guildId?` | `public` | `string` | `undefined` | The ID of the guild this channel is in | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`guildId` |
37
+ | `id` | `public` | `string` | `undefined` | The id of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`id` |
38
+ | `name?` | `public` | `string` | `undefined` | The name of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`name` |
39
+ | `nsfw?` | `public` | `boolean` | `undefined` | Whether the channel is marked as nsfw. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`nsfw` |
40
+ | `parentId?` | `public` | `null` \| `string` | `undefined` | The ID of the parent category for the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`parentId` |
41
+ | `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. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`partial` |
42
+ | `position?` | `public` | `number` | `undefined` | The position of the channel in the channel list. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`position` |
43
+ | `rawData` | `protected` | `null` \| `APIGuildStageVoiceChannel` | `null` | The raw data of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`rawData` |
44
+ | `type?` | `public` | `GuildStageVoice` | `undefined` | The type of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`type` |
45
+
46
+ ## Accessors
47
+
48
+ ### guild
49
+
50
+ > `get` **guild**(): [`Guild`](/carbon/api/classes/Guild)
51
+
52
+ The guild this channel is in
53
+
54
+ #### Returns
55
+
56
+ [`Guild`](/carbon/api/classes/Guild)
57
+
58
+ #### Inherited from
59
+
60
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`guild`](/carbon/api/classes/BaseGuildChannel#guild)
61
+
62
+ ## Methods
63
+
64
+ ### createInvite()
65
+
66
+ > **createInvite**(`options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
67
+
68
+ Create an invite for the channel
69
+
70
+ #### Parameters
71
+
72
+ | Parameter | Type |
73
+ | ------ | ------ |
74
+ | `options`? | `RESTPostAPIChannelInviteJSONBody` |
75
+
76
+ #### Returns
77
+
78
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
79
+
80
+ #### Inherited from
81
+
82
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`createInvite`](/carbon/api/classes/BaseGuildChannel#createinvite)
83
+
84
+ ***
85
+
86
+ ### fetch()
87
+
88
+ > **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
89
+
90
+ Fetches the channel from the API.
91
+
92
+ #### Returns
93
+
94
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
95
+
96
+ The channel data.
97
+
98
+ #### Inherited from
99
+
100
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`fetch`](/carbon/api/classes/BaseGuildChannel#fetch)
101
+
102
+ ***
103
+
104
+ ### getInvites()
105
+
106
+ > **getInvites**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
107
+
108
+ Get the invites for the channel
109
+
110
+ #### Returns
111
+
112
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
113
+
114
+ #### Inherited from
115
+
116
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`getInvites`](/carbon/api/classes/BaseGuildChannel#getinvites)
117
+
118
+ ***
119
+
120
+ ### send()
121
+
122
+ > **send**(`message`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
123
+
124
+ Send a message to the channel
125
+
126
+ #### Parameters
127
+
128
+ | Parameter | Type |
129
+ | ------ | ------ |
130
+ | `message` | `APIMessage` |
131
+
132
+ #### Returns
133
+
134
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
135
+
136
+ #### Inherited from
137
+
138
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`send`](/carbon/api/classes/BaseGuildChannel#send)
139
+
140
+ ***
141
+
142
+ ### setData()
143
+
144
+ > `protected` **setData**(`data`): `void`
145
+
146
+ #### Parameters
147
+
148
+ | Parameter | Type |
149
+ | ------ | ------ |
150
+ | `data` | `APIGuildChannel`\<`GuildStageVoice`\> |
151
+
152
+ #### Returns
153
+
154
+ `void`
155
+
156
+ #### Inherited from
157
+
158
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setData`](/carbon/api/classes/BaseGuildChannel#setdata)
159
+
160
+ ***
161
+
162
+ ### setName()
163
+
164
+ > **setName**(`name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
165
+
166
+ Set the name of the channel
167
+
168
+ #### Parameters
169
+
170
+ | Parameter | Type | Description |
171
+ | ------ | ------ | ------ |
172
+ | `name` | `string` | The new name of the channel |
173
+
174
+ #### Returns
175
+
176
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
177
+
178
+ #### Inherited from
179
+
180
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setName`](/carbon/api/classes/BaseGuildChannel#setname)
181
+
182
+ ***
183
+
184
+ ### setNsfw()
185
+
186
+ > **setNsfw**(`nsfw`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
187
+
188
+ Set whether the channel is nsfw
189
+
190
+ #### Parameters
191
+
192
+ | Parameter | Type | Description |
193
+ | ------ | ------ | ------ |
194
+ | `nsfw` | `boolean` | The new nsfw status of the channel |
195
+
196
+ #### Returns
197
+
198
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
199
+
200
+ #### Inherited from
201
+
202
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setNsfw`](/carbon/api/classes/BaseGuildChannel#setnsfw)
203
+
204
+ ***
205
+
206
+ ### setParent()
207
+
208
+ > **setParent**(`parent`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
209
+
210
+ Set the parent ID of the channel
211
+
212
+ #### Parameters
213
+
214
+ | Parameter | Type | Description |
215
+ | ------ | ------ | ------ |
216
+ | `parent` | `string` \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) | The new category channel or ID to set |
217
+
218
+ #### Returns
219
+
220
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
221
+
222
+ #### Inherited from
223
+
224
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setParent`](/carbon/api/classes/BaseGuildChannel#setparent)
225
+
226
+ ***
227
+
228
+ ### setPosition()
229
+
230
+ > **setPosition**(`position`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
231
+
232
+ Set the position of the channel
233
+
234
+ #### Parameters
235
+
236
+ | Parameter | Type | Description |
237
+ | ------ | ------ | ------ |
238
+ | `position` | `number` | The new position of the channel |
239
+
240
+ #### Returns
241
+
242
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
243
+
244
+ #### Inherited from
245
+
246
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setPosition`](/carbon/api/classes/BaseGuildChannel#setposition)
247
+
248
+ ***
249
+
250
+ ### setSpecificData()
251
+
252
+ > `protected` **setSpecificData**(): `void`
253
+
254
+ #### Returns
255
+
256
+ `void`
257
+
258
+ #### Overrides
259
+
260
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setSpecificData`](/carbon/api/classes/BaseGuildChannel#setspecificdata)
261
+
262
+ ***
263
+
264
+ ### triggerTyping()
265
+
266
+ > **triggerTyping**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
267
+
268
+ Trigger a typing indicator in the channel (this will expire after 10 seconds)
269
+
270
+ #### Returns
271
+
272
+ [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
273
+
274
+ #### Inherited from
275
+
276
+ [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`triggerTyping`](/carbon/api/classes/BaseGuildChannel#triggertyping)