Skip to content

Commit f3888e4

Browse files
committed
docs: update api reference for dev build
1 parent 141d140 commit f3888e4

File tree

250 files changed

+986
-996
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

250 files changed

+986
-996
lines changed

apps/website/docs/api-reference/classes/AppCommandHandler.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ new AppCommandHandler(commandkit)
1717

1818
## Properties
1919
### public commandkit: any
20-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L102)
20+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L101)
2121
### public commandRunner: any
22-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L97)
22+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L96)
2323
### public externalCommandData: any
24-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L99)
24+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L98)
2525
### public externalMiddlewareData: any
26-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L100)
26+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L99)
2727
### public registrar: any
28-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L94)
28+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L93)
2929

3030
## Methods
3131
### public addExternalCommands(data): [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)>
@@ -34,43 +34,43 @@ new AppCommandHandler(commandkit)
3434
| data | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Command> ||
3535

3636

37-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L422)
37+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L421)
3838
### public addExternalMiddleware(data): [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)>
3939
| Parameter | Type | Optional |
4040
| ----------- | ----------- | ----------- |
4141
| data | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Middleware> ||
4242

4343

44-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L414)
44+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L413)
4545
### public getCommandsArray(): [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<LoadedCommand>
46-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L241)
46+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L240)
4747
### public loadCommands(): [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)>
48-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L443)
48+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L442)
4949
### public prepareCommandRun(source, cmdName?): [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<null | PreparedAppCommandExecution>
5050
| Parameter | Type | Optional |
5151
| ----------- | ----------- | ----------- |
5252
| source | [Interaction](https://discord.js.org/docs/packages/discord.js/main/Interaction:Class) | Message ||
5353
| cmdName | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) ||
5454

5555

56-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L293)
56+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L292)
5757
### public printBanner(): [void](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)
58-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L106)
58+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L105)
5959
### public registerCommandHandler(): [void](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)
60-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L245)
60+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L244)
6161
### public registerExternalLoadedCommands(data): [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)>
6262
| Parameter | Type | Optional |
6363
| ----------- | ----------- | ----------- |
6464
| data | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<LoadedCommand> ||
6565

6666

67-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L436)
67+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L435)
6868
### public registerExternalLoadedMiddleware(data): [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)>
6969
| Parameter | Type | Optional |
7070
| ----------- | ----------- | ----------- |
7171
| data | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<LoadedMiddleware> ||
7272

7373

74-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L430)
74+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L429)
7575
### public reloadCommands(): [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)>
76-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L403)
76+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/app/handlers/AppCommandHandler.ts#L402)

apps/website/docs/api-reference/classes/ButtonKit.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The API data associated with this component.
2323
### public clearId(): this
2424
Clears the id of this component, defaulting to a default incremented id.
2525
### public dispose(): ButtonKit
26-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/components/v1/button/ButtonKit.ts#L222)
26+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/components/v1/button/ButtonKit.ts#L222)
2727
### public filter(predicate): this
2828
Sets a filter for the interaction collector.
2929

@@ -34,7 +34,7 @@ Sets a filter for the interaction collector.
3434
| predicate | ButtonKitPredicate || The filter to use for the interaction collector |
3535

3636

37-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/components/v1/button/ButtonKit.ts#L164)
37+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/components/v1/button/ButtonKit.ts#L164)
3838
### public onClick(handler, data?): this
3939
Sets up an inline interaction collector for this button. This collector by default allows as many interactions as possible if it is actively used.
4040
If unused, this expires after 24 hours or custom time if specified.
@@ -63,14 +63,14 @@ button.onClick(null);
6363
| data | CommandKitButtonBuilderInteractionCollectorDispatchContextData || The context data to use for the interaction collector |
6464

6565

66-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/components/v1/button/ButtonKit.ts#L92)
66+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/components/v1/button/ButtonKit.ts#L92)
6767
### public onEnd(handler): this
6868
| Parameter | Type | Optional |
6969
| ----------- | ----------- | ----------- |
7070
| handler | CommandKitButtonBuilderOnEnd ||
7171

7272

73-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/components/v1/button/ButtonKit.ts#L125)
73+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/components/v1/button/ButtonKit.ts#L125)
7474
### public onError(handler): this
7575
Sets the handler to run when the interaction collector ends.
7676

@@ -81,7 +81,7 @@ Sets the handler to run when the interaction collector ends.
8181
| handler | EventInterceptorErrorHandler || The handler to run when the interaction collector ends. |
8282

8383

84-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/components/v1/button/ButtonKit.ts#L147)
84+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/components/v1/button/ButtonKit.ts#L147)
8585
### public setCustomId(customId): this
8686
Sets the custom id for this button.
8787

apps/website/docs/api-reference/classes/CacheProvider.mdx

Lines changed: 0 additions & 57 deletions
This file was deleted.

apps/website/docs/api-reference/classes/ChannelSelectMenuKit.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Adds default channels to this auto populated select menu.
3939
### public clearId(): this
4040
Clears the id of this component, defaulting to a default incremented id.
4141
### public dispose(): ChannelSelectMenuKit
42-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/components/v1/select-menu/ChannelSelectMenuKit.ts#L193)
42+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/components/v1/select-menu/ChannelSelectMenuKit.ts#L193)
4343
### public filter(predicate): this
4444
Sets a filter for the interaction collector.
4545

@@ -50,7 +50,7 @@ Sets a filter for the interaction collector.
5050
| predicate | SelectMenuKitPredicate\<ChannelSelectMenuInteraction> || The filter to use for the interaction collector. |
5151

5252

53-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/components/v1/select-menu/ChannelSelectMenuKit.ts#L139)
53+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/components/v1/select-menu/ChannelSelectMenuKit.ts#L139)
5454
### public onEnd(handler): this
5555
Sets the handler to run when the interaction collector ends.
5656

@@ -61,7 +61,7 @@ Sets the handler to run when the interaction collector ends.
6161
| handler | CommandKitSelectMenuBuilderOnEnd || The handler to run when the interaction collector ends. |
6262

6363

64-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/components/v1/select-menu/ChannelSelectMenuKit.ts#L103)
64+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/components/v1/select-menu/ChannelSelectMenuKit.ts#L103)
6565
### public onError(handler): this
6666
Sets the handler to run when the interaction collector ends.
6767

@@ -72,7 +72,7 @@ Sets the handler to run when the interaction collector ends.
7272
| handler | EventInterceptorErrorHandler || The handler to run when the interaction collector ends. |
7373

7474

75-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/components/v1/select-menu/ChannelSelectMenuKit.ts#L121)
75+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/components/v1/select-menu/ChannelSelectMenuKit.ts#L121)
7676
### public onSelect(handler, data?): this
7777
Sets the handler to run when the modal is submitted.
7878

@@ -93,7 +93,7 @@ const modal = new ChannelSelectMenuKit()
9393
| data | CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData || The context data for the interaction collector. |
9494

9595

96-
- [Source](https://github.com/underctrl-io/commandkit/blob/e7997746676c2b18be64230c918cb998973d18b5/packages/commandkit/src/components/v1/select-menu/ChannelSelectMenuKit.ts#L65)
96+
- [Source](https://github.com/underctrl-io/commandkit/blob/141d1404ab18a8e659209a0fab65466bf3b6dd85/packages/commandkit/src/components/v1/select-menu/ChannelSelectMenuKit.ts#L65)
9797
### public setChannelTypes(types): this
9898
Sets channel types for this select menu.
9999

0 commit comments

Comments
 (0)