Archived
added JSDoc comments to methods that were not commented
This commit is contained in:
1 parent
a1ffd7c9d9
commit
64e15ba3c2
2 files changed
+15
-1
No files matched your search
@@ -154,6 +154,10 @@ export class Command {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string|string[]} phrase?
|
||||||
|
* @returns string
|
||||||
|
*/
|
||||||
private static processPhrase(phrase?: string | string[]): string[] | undefined {
|
private static processPhrase(phrase?: string | string[]): string[] | undefined {
|
||||||
if (Array.isArray(phrase)) {
|
if (Array.isArray(phrase)) {
|
||||||
const buff = phrase.map((p) => {
|
const buff = phrase.map((p) => {
|
||||||
@@ -174,6 +178,9 @@ export class Command {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns string
|
||||||
|
*/
|
||||||
private generateUsageFromArguments(): string {
|
private generateUsageFromArguments(): string {
|
||||||
let usageTemplate: string = "";
|
let usageTemplate: string = "";
|
||||||
this.parameters &&
|
this.parameters &&
|
||||||
|
|||||||
@@ -9,6 +9,10 @@ export class CommandManager {
|
|||||||
prefix?: string;
|
prefix?: string;
|
||||||
argumentSeparator: string;
|
argumentSeparator: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} prefix?
|
||||||
|
* @param {string} argumentSeparator?
|
||||||
|
*/
|
||||||
constructor(prefix?: string, argumentSeparator?: string) {
|
constructor(prefix?: string, argumentSeparator?: string) {
|
||||||
this.list = [];
|
this.list = [];
|
||||||
this.prefix = prefix;
|
this.prefix = prefix;
|
||||||
@@ -18,7 +22,6 @@ export class CommandManager {
|
|||||||
/**
|
/**
|
||||||
* Retrieves the command by name, alias or keyword
|
* Retrieves the command by name, alias or keyword
|
||||||
* @param {string} phrase - command name, alias or keyword
|
* @param {string} phrase - command name, alias or keyword
|
||||||
* @param {GetMode} [mode='ALL'] - specifies which types of command triggers will be used to find the command [*NO_PREFIX* - only keywords; *PREFIX* - names and aliases]
|
|
||||||
* @returns *Command* | *null*
|
* @returns *Command* | *null*
|
||||||
*/
|
*/
|
||||||
get(phrase: string): Command | null {
|
get(phrase: string): Command | null {
|
||||||
@@ -178,6 +181,10 @@ export class CommandManager {
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} phrase?
|
||||||
|
* @returns PhraseOccurrenceData
|
||||||
|
*/
|
||||||
private findPhraseOccurrence(phrase?: string): PhraseOccurrenceData | null {
|
private findPhraseOccurrence(phrase?: string): PhraseOccurrenceData | null {
|
||||||
let returnValue: PhraseOccurrenceData | null = null;
|
let returnValue: PhraseOccurrenceData | null = null;
|
||||||
this.list.map((c) => {
|
this.list.map((c) => {
|
||||||
|
|||||||
Reference in new issue
Block a user