Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-12 01:23:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(builders/components): document constructors (#8636)

Browse Source
This commit is contained in:
Almeida
2022-09-19 01:32:28 +01:00
committed by GitHub
parent 6d43e26676
commit 8444576f45
5 changed files with 119 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
packages/builders/src/components/button/Button.ts
View File

@@ -29,24 +29,24 @@ export class ButtonBuilder extends ComponentBuilder<APIButtonComponent> {
* Creating a button from an API data object
* ```ts
* const button = new ButtonBuilder({
* style: 'primary',
* custom_id: 'a cool button',
* style: ButtonStyle.Primary,
* label: 'Click Me',
* emoji: {
* name: ':smile:',
* id: '12345678901234567890123456789012',
* name: 'smile',
* id: '123456789012345678',
* },
* custom_id: '12345678901234567890123456789012',
* });
* ```
* @example
* Creating a button using setters and API data
* ```ts
* const button = new ButtonBuilder({
* style: 'primary',
* style: ButtonStyle.Secondary,
* label: 'Click Me',
* })
* .setEmoji({ name: ':smile:', id: '12345678901234567890123456789012' })
* .setCustomId('12345678901234567890123456789012');
* .setEmoji({ name: '🙂' })
* .setCustomId('another cool button');
* ```
*/
public constructor(data?: Partial<APIButtonComponent>) {