Class CommandPalette

constructor

• new CommandPalette(): CommandPalette

  Returns CommandPalette

Readonlycommands

get

• get(name: string): undefined | Command<unknown>

  Gets a command by its name.

  Parameters

  • name: string

    The name of the command.

  Returns undefined | Command<unknown>

  The command or undefined if it does not exist.

getAll

• getAll(): Command<unknown>[]

  Gets all the commands in the registry.

  Returns Command<unknown>[]

  All the commands in the registry.

register

• register<K = {}, T = CommandContext<K>>(
      name: string,
      description: string,
      callback: CommandCallback<T>,
      aliases?: string[],
  ): Command<T>

  Registers a new command in the registry.

  Type Parameters

  • K = {}
  • T = CommandContext<K>

  Parameters

  • name: string

    The name of the command.
  • description: string

    The description of the command.
  • callback: CommandCallback<T>

    The callback of the command.
  • Optionalaliases: string[]

    The aliases of the command.

  Returns Command<T>

  The command that was registered.
• register<K = {}, T = CommandContext<K>>(
      name: string,
      description: string,
      registry: CommandRegistryCallback,
      callback: CommandCallback<T>,
      aliases?: string[],
  ): Command<T>

  Registers a new command in the registry.

  Type Parameters

  • K = {}
  • T = CommandContext<K>

  Parameters

  • name: string

    The name of the command.
  • description: string

    The description of the command.
  • registry: CommandRegistryCallback

    The registry of the command.
  • callback: CommandCallback<T>

    The callback of the command.
  • Optionalaliases: string[]

    The aliases of the command.

  Returns Command<T>

  The command that was registered.

unregister

• unregister(name: string): void

  Unregisters a command from the registry by its name.

  Parameters

  • name: string

    The name of the command to be unregistered.

  Returns void

  Remarks

  This method removes the command associated with the given name from the registry. If the command does not exist in the registry, this method does nothing.