Skip to content

Commit

Permalink
remove experimental hooks
Browse files Browse the repository at this point in the history
  • Loading branch information
notunderctrl committed Dec 14, 2024
1 parent 6ce87cb commit c89338e
Show file tree
Hide file tree
Showing 30 changed files with 59 additions and 95 deletions.
6 changes: 3 additions & 3 deletions apps/docs/content/docs/classes/ButtonKit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The API data associated with this component.

### public dispose(): ButtonKit

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/components/ButtonKit.ts#L165)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L165)

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

Expand Down Expand Up @@ -59,15 +59,15 @@ button.onClick(null);
| handler | CommandKitButtonBuilderInteractionCollectorDispatch || The handler to run when the button is clicked |
| data | CommandKitButtonBuilderInteractionCollectorDispatchContextData || The context data to use for the interaction collector |

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/components/ButtonKit.ts#L74)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L74)

### public onEnd(handler): this

| Parameter | Type | Optional |
| --------- | ---------------------------- | -------- |
| handler | CommandKitButtonBuilderOnEnd ||

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/components/ButtonKit.ts#L98)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L98)

### public setCustomId(customId): this

Expand Down
26 changes: 13 additions & 13 deletions apps/docs/content/docs/classes/CommandKit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,47 +17,47 @@ CommandKit(options);

### public static \_instance: any

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L8)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L12)

### public client: any

Get the client attached to this CommandKit instance.

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L38)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L42)

### public commandHandler: any

Get command handler instance.

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L45)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L49)

### public commands: any

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

### public commandsPath: any

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

### public devGuildIds: any

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

### public devRoleIds: any

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

### public devUserIds: any

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

### public eventsPath: any

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

### public validationsPath: any

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L155)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L158)

## Methods

Expand All @@ -69,16 +69,16 @@ Updates application commands with the latest from "commandsPath".
| --------- | ------------- | -------- |
| type | ReloadOptions ||

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

### 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)>

Updates application events with the latest from "eventsPath".

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L109)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L112)

### 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)>

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

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/CommandKit.ts#L117)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/CommandKit.ts#L120)
2 changes: 1 addition & 1 deletion apps/docs/content/docs/enums/ReloadType.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ description: No description provided
| Developer | 'dev' | N/A | Reload developer/guild commands. |
| Global | 'global' | N/A | Reload global commands. |

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/types.ts#L284)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L275)
2 changes: 1 addition & 1 deletion apps/docs/content/docs/functions/defineConfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ description: No description provided
| --------- | ---------------------------------------------------------------- | -------- |
| config | PartialConfig\<[CommandKitConfig](/docs/types/CommandKitConfig)> ||

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/config.ts#L71)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/config.ts#L71)
2 changes: 1 addition & 1 deletion apps/docs/content/docs/functions/getConfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: No description provided

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

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/config.ts#L60)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/config.ts#L60)
2 changes: 1 addition & 1 deletion apps/docs/content/docs/types/AutocompleteProps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Props for autocomplete command run functions.
| handler | [CommandKit](/docs/classes/CommandKit) | N/A | The current CommandKit handler instance. |
| interaction | AutocompleteInteraction\<CacheType> | N/A | The current autocomplete command interaction object. |

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/types.ts#L146)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L137)
2 changes: 1 addition & 1 deletion apps/docs/content/docs/types/CommandContext.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Represents a command context.
| handler | [CommandKit](/docs/classes/CommandKit) | N/A | The command data. |
| interaction | Interaction\<CacheType> | N/A | The interaction that triggered this command. |

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/types.ts#L80)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L71)
2 changes: 1 addition & 1 deletion apps/docs/content/docs/types/CommandData.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ description: No description provided

- Type: RESTPostAPIApplicationCommandsJSONBody

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/types.ts#L256)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L247)
2 changes: 1 addition & 1 deletion apps/docs/content/docs/types/CommandFileObject.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Represents a command file.
| options | CommandOptions | N/A |
| run | ( ctx: CommandContext\<Interaction, Cached> ) => void | N/A |

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/types.ts#L101)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L92)
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ If the first argument is null, it means that the interaction collector has been
interaction: ButtonInteraction
) => Awaitable\<void>

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/components/ButtonKit.ts#L17)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L17)
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ description: No description provided
time: number
} & Omit\<InteractionCollectorOptions\<ButtonInteraction>, 'filter' \| 'componentType'>

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/components/ButtonKit.ts#L23)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L23)
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ description: No description provided
...args: unknown\[]
) => Awaitable\<void>

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/components/ButtonKit.ts#L21)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L21)
2 changes: 1 addition & 1 deletion apps/docs/content/docs/types/CommandKitConfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ description: No description provided
| src | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | N/A | The source directory of the project. |
| watch | [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | N/A | Whether or not to use the watch mode. Defaults to `true`. |

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/config.ts#L1)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/config.ts#L1)
3 changes: 1 addition & 2 deletions apps/docs/content/docs/types/CommandKitData.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ Private data for the CommandKit class.
| devUserIds | Array\<string> | N/A | List of developer user IDs to restrict devOnly commands to. |
| eventHandler | EventHandler | N/A | N/A |
| eventsPath | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | N/A | The path to your events directory. |
| experimental | \{ hooks: boolean } | N/A | Options for experimental features. |
| skipBuiltInValidations | [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | N/A | Skip CommandKit's built-in validations (for devOnly commands). |
| validationHandler | ValidationHandler | N/A | N/A |
| validationsPath | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | N/A | The path to the validations directory. |

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/types.ts#L71)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L62)
3 changes: 1 addition & 2 deletions apps/docs/content/docs/types/CommandKitOptions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ Options for instantiating a CommandKit handler.
| devRoleIds | Array\<string> | N/A | List of developer role IDs to restrict devOnly commands to. |
| devUserIds | Array\<string> | N/A | List of developer user IDs to restrict devOnly commands to. |
| eventsPath | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | N/A | The path to your events directory. |
| experimental | \{ hooks: boolean } | N/A | Options for experimental features. |
| skipBuiltInValidations | [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | N/A | Skip CommandKit's built-in validations (for devOnly commands). |
| validationsPath | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | N/A | The path to the validations directory. |

- [Source](https://github.com/underctrl-io/commandkit/blob/fe9b9d88f8541b4758cc813e8505d26748e6e5bd/packages/commandkit/src/types.ts#L20)
- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L20)
2 changes: 1 addition & 1 deletion apps/docs/content/docs/types/CommandObject.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ description: No description provided
options: CommandOptions
}

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

0 comments on commit c89338e

Please sign in to comment.