Skip to content

Commit 4bec6eb

Browse files
committed
chore: docgen
1 parent 6ce87cb commit 4bec6eb

29 files changed

+136
-80
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/components/ButtonKit.ts#L165)
26+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/components/ButtonKit.ts#L74)
62+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/components/ButtonKit.ts#L98)
70+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L98)
7171

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

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,47 +17,47 @@ CommandKit(options);
1717

1818
### public static \_instance: any
1919

20-
- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L8)
20+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L38)
26+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L45)
32+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L49)
3333

3434
### public commands: any
3535

36-
- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L125)
36+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L129)
3737

3838
### public commandsPath: any
3939

40-
- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L141)
40+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L145)
4141

4242
### public devGuildIds: any
4343

44-
- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L169)
44+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L173)
4545

4646
### public devRoleIds: any
4747

48-
- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L176)
48+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L180)
4949

5050
### public devUserIds: any
5151

52-
- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L162)
52+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L166)
5353

5454
### public eventsPath: any
5555

56-
- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L148)
56+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L152)
5757

5858
### public validationsPath: any
5959

60-
- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L155)
60+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L159)
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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L101)
72+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L105)
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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L109)
78+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L113)
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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L117)
84+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L121)

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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/types.ts#L284)
13+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L284)

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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/config.ts#L71)
12+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/config.ts#L60)
8+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/config.ts#L60)

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ description: Props for autocomplete command run functions.
77

88
Props for autocomplete command run functions.
99

10-
| Property | Type | Value | Description |
11-
| ----------- | -------------------------------------- | ----- | --------------------------------------------------------- |
12-
| client | Client\<true> | N/A | The Discord.js client object that CommandKit is handling. |
13-
| handler | [CommandKit](/docs/classes/CommandKit) | N/A | The current CommandKit handler instance. |
14-
| interaction | AutocompleteInteraction\<CacheType> | N/A | The current autocomplete command interaction object. |
10+
| Property | Type | Value | Description |
11+
| ----------- | ------------------------------------------------------------------------------------------------------------------------- | ----- | --------------------------------------------------------- |
12+
| client | [Client\<true>](https://discord.js.org/docs/packages/discord.js/main/Client:Class) | N/A | The Discord.js client object that CommandKit is handling. |
13+
| handler | [CommandKit](/docs/classes/CommandKit) | N/A | The current CommandKit handler instance. |
14+
| 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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/types.ts#L146)
16+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L146)

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> | 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> | N/A | The interaction that triggered this command. |
1515

16-
- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/types.ts#L80)
16+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L80)

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

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

88
- Type: RESTPostAPIApplicationCommandsJSONBody
99

10-
- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/types.ts#L256)
10+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L256)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ Represents a command file.
1616
| options | CommandOptions | N/A |
1717
| run | ( ctx: CommandContext\<Interaction, Cached> ) => void | N/A |
1818

19-
- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/types.ts#L101)
19+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L101)

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/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/components/ButtonKit.ts#L17)
15+
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L17)

0 commit comments

Comments
 (0)