Class Suggestion

Index

Constructors

Methods

apply compareTo compareToIgnoreCase equals expand getRange getText getTooltip toString

Constructors

constructor

new Suggestion(
    range: StringRange,
    text: string,
    tooltip?: Message | null,
): Suggestion
Parameters
- range: StringRange
- text: string
- tooltip: Message | null = null
Returns Suggestion
- Defined in packages/brigadier/src/suggestion/Suggestion.ts:10

Methods

apply

apply(input: string): string
Parameters
- input: string
Returns string
- Defined in packages/brigadier/src/suggestion/Suggestion.ts:28

compareTo

compareTo(o: Suggestion): number
Parameters
- o: Suggestion
Returns number
- Defined in packages/brigadier/src/suggestion/Suggestion.ts:68

compareToIgnoreCase

compareToIgnoreCase(b: Suggestion): number
Parameters
- b: Suggestion
Returns number
- Defined in packages/brigadier/src/suggestion/Suggestion.ts:72

equals

equals(o: object): boolean
Parameters
- o: object
Returns boolean
- Defined in packages/brigadier/src/suggestion/Suggestion.ts:46

expand

expand(command: string, range: StringRange): Suggestion
Parameters
- command: string
- range: StringRange
Returns Suggestion
- Defined in packages/brigadier/src/suggestion/Suggestion.ts:76

getRange

getRange(): StringRange
Returns StringRange
- Defined in packages/brigadier/src/suggestion/Suggestion.ts:16

getText

getText(): string
Returns string
- Defined in packages/brigadier/src/suggestion/Suggestion.ts:20

getTooltip

getTooltip(): Message | null
Returns Message | null
- Defined in packages/brigadier/src/suggestion/Suggestion.ts:24

toString

toString(): String
Returns String
- Defined in packages/brigadier/src/suggestion/Suggestion.ts:53