Skip to content

Commit

Permalink
chore: docgen
Browse files Browse the repository at this point in the history
  • Loading branch information
twlite committed Dec 14, 2024
1 parent 843899e commit 6165e6a
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 11 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/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L165)
- [Source](https://github.com/underctrl-io/commandkit/blob/4bec6eb15c6d8d01a8ef971868bc7d589a20269e/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/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L74)
- [Source](https://github.com/underctrl-io/commandkit/blob/4bec6eb15c6d8d01a8ef971868bc7d589a20269e/packages/commandkit/src/components/ButtonKit.ts#L74)

### public onEnd(handler): this

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

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

### public setCustomId(customId): this

Expand Down
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/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/config.ts#L71)
- [Source](https://github.com/underctrl-io/commandkit/blob/4bec6eb15c6d8d01a8ef971868bc7d589a20269e/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/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/config.ts#L60)
- [Source](https://github.com/underctrl-io/commandkit/blob/4bec6eb15c6d8d01a8ef971868bc7d589a20269e/packages/commandkit/src/config.ts#L60)
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/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L17)
- [Source](https://github.com/underctrl-io/commandkit/blob/4bec6eb15c6d8d01a8ef971868bc7d589a20269e/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/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L23)
- [Source](https://github.com/underctrl-io/commandkit/blob/4bec6eb15c6d8d01a8ef971868bc7d589a20269e/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/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/components/ButtonKit.ts#L21)
- [Source](https://github.com/underctrl-io/commandkit/blob/4bec6eb15c6d8d01a8ef971868bc7d589a20269e/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/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/config.ts#L1)
- [Source](https://github.com/underctrl-io/commandkit/blob/4bec6eb15c6d8d01a8ef971868bc7d589a20269e/packages/commandkit/src/config.ts#L1)
2 changes: 1 addition & 1 deletion apps/docs/content/docs/types/CommandKitOptions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Options for instantiating a CommandKit handler.
| 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/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/types.ts#L20)
- [Source](https://github.com/underctrl-io/commandkit/blob/4bec6eb15c6d8d01a8ef971868bc7d589a20269e/packages/commandkit/src/types.ts#L20)
2 changes: 1 addition & 1 deletion apps/docs/content/docs/variables/version.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ The current version of CommandKit.

- Type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)

- [Source](https://github.com/underctrl-io/commandkit/blob/6ce87cba44f953b46a72430cb1272818640529f4/packages/commandkit/src/index.ts#L11)
- [Source](https://github.com/underctrl-io/commandkit/blob/4bec6eb15c6d8d01a8ef971868bc7d589a20269e/packages/commandkit/src/index.ts#L11)

0 comments on commit 6165e6a

Please sign in to comment.