Skip to content

Commit c2f316b

Browse files
twlitetwlite
committed
chore: docgen
1 parent 7e608cc commit c2f316b

28 files changed

+99
-71
lines changed

‎apps/docs/content/docs/classes/ButtonKit.mdx‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: No description provided
66
## ButtonKit extends ButtonBuilder
77

88
```typescript
9-
ButtonKit(data);
9+
new ButtonKit(data);
1010
```
1111

1212
| Parameter | Type | Optional |
@@ -23,7 +23,7 @@ The API data associated with this component.
2323

2424
### public dispose(): ButtonKit
2525

26-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/components/ButtonKit.ts#L165)
26+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/components/ButtonKit.ts#L165)
2727

2828
### public onClick(handler, data?): this
2929

@@ -59,15 +59,15 @@ button.onClick(null);
5959
| handler | CommandKitButtonBuilderInteractionCollectorDispatch | ❌ | The handler to run when the button is clicked |
6060
| data | CommandKitButtonBuilderInteractionCollectorDispatchContextData | ✅ | The context data to use for the interaction collector |
6161

62-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/components/ButtonKit.ts#L74)
62+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/components/ButtonKit.ts#L74)
6363

6464
### public onEnd(handler): this
6565

6666
| Parameter | Type | Optional |
6767
| --------- | ---------------------------- | -------- |
6868
| handler | CommandKitButtonBuilderOnEnd | ❌ |
6969

70-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/components/ButtonKit.ts#L98)
70+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/components/ButtonKit.ts#L98)
7171

7272
### public setCustomId(customId): this
7373

@@ -89,9 +89,9 @@ Sets whether this button is disabled.
8989

9090
Sets the emoji to display on this button.
9191

92-
| Parameter | Type | Optional | Description |
93-
| --------- | ------------------------ | -------- | ---------------- |
94-
| emoji | ComponentEmojiResolvable | ❌ | The emoji to use |
92+
| Parameter | Type | Optional | Description |
93+
| --------- | ------------------------------------------------------------------------------------------------------------------- | -------- | ---------------- |
94+
| emoji | [ComponentEmojiResolvable](https://discord.js.org/docs/packages/discord.js/main/ComponentEmojiResolvable:TypeAlias) | ❌ | The emoji to use |
9595

9696
### public setLabel(label): this
9797

@@ -113,9 +113,9 @@ Sets the SKU id that represents a purchasable SKU for this button.
113113

114114
Sets the style of this button.
115115

116-
| Parameter | Type | Optional | Description |
117-
| --------- | ----------- | -------- | ---------------- |
118-
| style | ButtonStyle | ❌ | The style to use |
116+
| Parameter | Type | Optional | Description |
117+
| --------- | --------------------------------------------------------------------------------------- | -------- | ---------------- |
118+
| style | [ButtonStyle](https://discord-api-types.dev/api/discord-api-types-v10/enum/ButtonStyle) | ❌ | The style to use |
119119

120120
### public setURL(url): this
121121

@@ -125,12 +125,12 @@ Sets the URL for this button.
125125
| --------- | ------------------------------------------------------------------------------------------------- | -------- | -------------- |
126126
| url | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ❌ | The URL to use |
127127

128-
### public toJSON(): APIButtonComponent
128+
### public toJSON(): [APIButtonComponent](https://discord-api-types.dev/api/discord-api-types-v10#APIButtonComponent)
129129

130130
ComponentBuilder.toJSON
131131

132132
### public static from(other): ButtonBuilder
133133

134-
| Parameter | Type | Optional |
135-
| --------- | ------------------ | ---------------------------------- | --- |
136-
| other | APIButtonComponent | JSONEncodable\<APIButtonComponent> | ❌ |
134+
| Parameter | Type | Optional |
135+
| --------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | --- |
136+
| other | [APIButtonComponent](https://discord-api-types.dev/api/discord-api-types-v10#APIButtonComponent) | JSONEncodable\<[APIButtonComponent](https://discord-api-types.dev/api/discord-api-types-v10#APIButtonComponent)> | ❌ |

‎apps/docs/content/docs/classes/CommandKit.mdx‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: No description provided
66
## CommandKit
77

88
```typescript
9-
CommandKit(options);
9+
new CommandKit(options);
1010
```
1111

1212
| Parameter | Type | Optional | Description |
@@ -17,47 +17,47 @@ CommandKit(options);
1717

1818
### public static \_instance: any
1919

20-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L12)
20+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L12)
2121

2222
### public client: any
2323

2424
Get the client attached to this CommandKit instance.
2525

26-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L42)
26+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L42)
2727

2828
### public commandHandler: any
2929

3030
Get command handler instance.
3131

32-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L49)
32+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L49)
3333

3434
### public commands: any
3535

36-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L128)
36+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L128)
3737

3838
### public commandsPath: any
3939

40-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L144)
40+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L144)
4141

4242
### public devGuildIds: any
4343

44-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L172)
44+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L172)
4545

4646
### public devRoleIds: any
4747

48-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L179)
48+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L179)
4949

5050
### public devUserIds: any
5151

52-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L165)
52+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L165)
5353

5454
### public eventsPath: any
5555

56-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L151)
56+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L151)
5757

5858
### public validationsPath: any
5959

60-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L158)
60+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L158)
6161

6262
## Methods
6363

@@ -69,16 +69,16 @@ Updates application commands with the latest from "commandsPath".
6969
| --------- | ------------- | -------- |
7070
| type | ReloadOptions | ✅ |
7171

72-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L104)
72+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L104)
7373

7474
### public reloadEvents(): [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[void](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)>
7575

7676
Updates application events with the latest from "eventsPath".
7777

78-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L112)
78+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L112)
7979

8080
### public reloadValidations(): [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[void](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)>
8181

8282
Updates application command validations with the latest from "validationsPath".
8383

84-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L120)
84+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L120)

‎apps/docs/content/docs/enums/ReloadType.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ description: No description provided
1010
| Developer | 'dev' | N/A | Reload developer/guild commands. |
1111
| Global | 'global' | N/A | Reload global commands. |
1212

13-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L275)
13+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L275)

‎apps/docs/content/docs/functions/defineConfig.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ description: No description provided
99
| --------- | ---------------------------------------------------------------- | -------- |
1010
| config | PartialConfig\<[CommandKitConfig](/docs/types/CommandKitConfig)> | ❌ |
1111

12-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/config.ts#L71)
12+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/config.ts#L71)

‎apps/docs/content/docs/functions/getConfig.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ description: No description provided
55

66
### getConfig(): [CommandKitConfig](/docs/types/CommandKitConfig)
77

8-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/config.ts#L60)
8+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/config.ts#L60)

‎apps/docs/content/docs/types/AutocompleteProps.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ Props for autocomplete command run functions.
1313
| handler | [CommandKit](/docs/classes/CommandKit) | N/A | The current CommandKit handler instance. |
1414
| interaction | [AutocompleteInteraction\<CacheType>](https://discord.js.org/docs/packages/discord.js/main/AutocompleteInteraction:Class) | N/A | The current autocomplete command interaction object. |
1515

16-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L137)
16+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L137)

‎apps/docs/content/docs/types/CommandContext.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ description: Represents a command context.
77

88
Represents a command context.
99

10-
| Property | Type | Value | Description |
11-
| ----------- | ------------------------------------------------------------------------------------- | ----- | -------------------------------------------- |
12-
| client | [Client\<boolean>](https://discord.js.org/docs/packages/discord.js/main/Client:Class) | N/A | The client that instantiated this command. |
13-
| handler | [CommandKit](/docs/classes/CommandKit) | N/A | The command data. |
14-
| interaction | Interaction\<CacheType> | N/A | The interaction that triggered this command. |
10+
| Property | Type | Value | Description |
11+
| ----------- | ------------------------------------------------------------------------------------------------- | ----- | -------------------------------------------- |
12+
| client | [Client\<boolean>](https://discord.js.org/docs/packages/discord.js/main/Client:Class) | N/A | The client that instantiated this command. |
13+
| handler | [CommandKit](/docs/classes/CommandKit) | N/A | The command data. |
14+
| interaction | [Interaction\<CacheType>](https://discord.js.org/docs/packages/discord.js/main/Interaction:Class) | N/A | The interaction that triggered this command. |
1515

16-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L71)
16+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L71)

‎apps/docs/content/docs/types/CommandData.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ description: No description provided
55

66
## CommandData
77

8-
- Type: RESTPostAPIApplicationCommandsJSONBody
8+
- Type: [RESTPostAPIApplicationCommandsJSONBody](https://discord-api-types.dev/api/discord-api-types-v10#RESTPostAPIApplicationCommandsJSONBody)
99

10-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L247)
10+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L247)

‎apps/docs/content/docs/types/CommandFileObject.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ description: Represents a command file.
77

88
Represents a command file.
99

10-
| Property | Type | Value |
11-
| ------------ | ------------------------------------------------------------------------------------------------- | ----- |
12-
| autocomplete | ( ctx: CommandContext\<Interaction, Cached> ) => void | N/A |
13-
| category | null \| string | N/A |
14-
| data | RESTPostAPIApplicationCommandsJSONBody | N/A |
15-
| filePath | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | N/A |
16-
| options | CommandOptions | N/A |
17-
| run | ( ctx: CommandContext\<Interaction, Cached> ) => void | N/A |
10+
| Property | Type | Value |
11+
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ----- |
12+
| autocomplete | ( ctx: CommandContext\<Interaction, Cached> ) => void | N/A |
13+
| category | null \| string | N/A |
14+
| data | [RESTPostAPIApplicationCommandsJSONBody](https://discord-api-types.dev/api/discord-api-types-v10#RESTPostAPIApplicationCommandsJSONBody) | N/A |
15+
| filePath | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | N/A |
16+
| options | CommandOptions | N/A |
17+
| run | ( ctx: CommandContext\<Interaction, Cached> ) => void | N/A |
1818

19-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L92)
19+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L92)

‎apps/docs/content/docs/types/CommandKitButtonBuilderInteractionCollectorDispatch.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ If the first argument is null, it means that the interaction collector has been
1212
interaction: ButtonInteraction
1313
) => Awaitable\<void>
1414

15-
- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/components/ButtonKit.ts#L17)
15+
- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/components/ButtonKit.ts#L17)

0 commit comments

Comments
 (0)