Class CommandCollection

Hierarchy

ReadonlyCommandCollection
- CommandCollection

Implements

Iterable<Command>

Index

Properties

Methods

Properties

Protected _alias

_alias: Map<string, Command[]> = new Map<string, Command[]>()

Protected _commands

_commands: Map<string, Command> = new Map<string, Command>()

Methods

[Symbol.iterator]

[Symbol.iterator](): Iterator<Command>

Inherited from ReadonlyCommandCollection.[Symbol.iterator]
- Defined in src/models/CommandCollection.ts:7
Returns Iterator<Command>

add

add(command: Command): boolean

- Defined in src/models/CommandCollection.ts:45
Adds a command to the collection and returns true if successfully added, false otherwise.

Parameters
- command: Command
  
  The command to add.
Returns boolean

Either or not the command has been added.

delete

delete(command: Command): void

- Defined in src/models/CommandCollection.ts:65
Remove a command from this collection.

Parameters
- command: Command
  
  The command to remove.
Returns void

get

get(name: string): Command | undefined

Inherited from ReadonlyCommandCollection.get
- Defined in src/models/CommandCollection.ts:16
Returns a command by its name of its alias, or undefined if not found.

Parameters
- name: string
  
  The command's name or alias.
Returns Command | undefined

The command or undefined.

hasAlias

hasAlias(alias: string): boolean

Inherited from ReadonlyCommandCollection.hasAlias
- Defined in src/models/CommandCollection.ts:34
Determines if this collection contains the alias.

Parameters
- alias: string
  
  Alias to check.
Returns boolean

Either or not this collection contains the alias.

values

values(): IterableIterator<Command>

Inherited from ReadonlyCommandCollection.values
- Defined in src/models/CommandCollection.ts:25
Returns an iterable of commands in the collection.

Returns IterableIterator<Command>

Generated using TypeDoc