GlobalRuniumClass

Конструкторы классов для создания команд, задач, триггеров и других сущностей Runium.

Свойства

Наименование	Тип
RuniumCommand	typeof RuniumCommand
CommandArgument	typeof Argument
CommandOption	typeof Option
RuniumError	typeof RuniumError
RuniumTask	typeof RuniumTask
RuniumTrigger	typeof RuniumTrigger

Описание свойств

RuniumCommand

Тип: typeof RuniumCommand

Базовый класс для создания пользовательских команд Runium.

Пример:

class SomeCommand extends runium.class.RuniumCommand {
  protected config(): void {
    this.command.name("some-command").description("Some custom command")
  }

  protected async handle(...args: unknown[]): Promise<void> {
    runium.output.info("Command executed!")
  }
}

CommandArgument

Тип: typeof Argument

Класс для создания аргументов команды (из библиотеки Commander.js).

Пример:

const arg = new runium.class.CommandArgument("<name>", "Project name")

CommandOption

Тип: typeof Option

Класс для создания опций команды (из библиотеки Commander.js).

Пример:

const option = new runium.class.CommandOption(
  "-d, --debug",
  "Enable debug mode"
)

RuniumError

Тип: typeof RuniumError

Класс для создания ошибок Runium.

Пример:

throw new runium.class.RuniumError("Something went wrong", "ERROR_CODE", {
  payload: "Some additional info",
})

RuniumTask

Тип: typeof RuniumTask

Базовый класс для создания пользовательских задач Runium.

Пример:

class SomeTask extends runium.class.RuniumTask {
  // реализация
}

RuniumTrigger

Тип: typeof RuniumTrigger

Базовый класс для создания пользовательских триггеров Runium.

Пример:

class SomeTrigger extends runium.class.RuniumTrigger {
  // реализация
}