Skip to content

Commit

Permalink
docs(Command): update fullCategory's outdated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kyranet authored and favna committed Nov 18, 2023
1 parent e441115 commit d2d7967
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions src/lib/structures/Command.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,14 @@ export class Command<PreParseReturn = Args, Options extends Command.Options = Co
public detailedDescription: DetailedDescriptionCommand;

/**
* The full category for the command. Either an array of strings that denote every (sub)folder the command is in,
* or `null` if it could not be resolved automatically.
* The full category for the command, can be overridden by setting the {@link Command.Options.fullCategory} option.
*
* If {@link Command.Options.fullCategory} is not set, then:
* - If the command is loaded from the file system, then this is the command's location in file system relative to
* the commands folder. For example, if you have a command located at `commands/General/Information/info.ts` then
* this property will be `['General', 'Info']`.
* - If the command is virtual, then this will be `[]`.
*
* If this is `null` with how you set up your code then you can overwrite how the `fullCategory` is resolved by
* extending this class and overwriting the assignment in the constructor.
* @since 2.0.0
*/
public readonly fullCategory: readonly string[];
Expand Down

0 comments on commit d2d7967

Please sign in to comment.