GlobalRuniumOutput

Функции для вывода и логирования сообщений различных уровней.

Методы

Наименование	Описание
getLevel	Получить текущий уровень вывода
setLevel	Установить уровень вывода
trace	Вывести сообщение уровня TRACE
debug	Вывести сообщение уровня DEBUG
info	Вывести сообщение уровня INFO
warn	Вывести сообщение уровня WARN
error	Вывести сообщение уровня ERROR
log	Вывести сообщение
success	Вывести сообщение об успехе
table	Вывести данные в виде таблицы
tree	Вывести данные в виде дерева
divider	Вывести линию-разделитель
box	Вывести текст в рамке
spinner	Показать спиннер
progress	Вывести индикатор прогресса
writeStdout	Записать сообщение в stdout
writeStderr	Записать сообщение в stderr

Описание методов

getLevel

getLevel(): OutputLevel

Получает текущий уровень вывода.

Возвращает: OutputLevel - текущий уровень вывода

Пример:

const level = runium.output.getLevel()
console.log("Current level:", level)

setLevel

setLevel(level: OutputLevel): void

Устанавливает уровень вывода.

Параметры:

• level (OutputLevel) - уровень вывода для установки

Пример:

runium.output.setLevel(runium.enum.OutputLevel.DEBUG)

trace

trace(message: string, ...args: unknown[]): void

Выводит сообщение уровня TRACE.

Параметры:

• message (string) - сообщение для вывода
• args (unknown[]) - дополнительные аргументы для вывода

Пример:

runium.output.trace("Trace message", { detail: "value" })

debug

debug(message: string, ...args: unknown[]): void

Выводит сообщение уровня DEBUG.

Параметры:

• message (string) - сообщение для вывода
• args (unknown[]) - дополнительные аргументы для вывода

Пример:

runium.output.debug("Debug message", { detail: "value" })

info

info(message: string, ...args: unknown[]): void

Выводит сообщение уровня INFO.

Параметры:

• message (string) - сообщение для вывода
• args (unknown[]) - дополнительные аргументы для вывода

Пример:

runium.output.info("Info message", { detail: "value" })

warn

warn(message: string, ...args: unknown[]): void

Выводит сообщение уровня WARN.

Параметры:

• message (string) - сообщение для вывода
• args (unknown[]) - дополнительные аргументы для вывода

Пример:

runium.output.warn("Warning message", { detail: "value" })

error

error(message: string, ...args: unknown[]): void

Выводит сообщение уровня ERROR.

Параметры:

• message (string) - сообщение для вывода
• args (unknown[]) - дополнительные аргументы для вывода

Пример:

runium.output.error("Error message", { detail: "value" })

log

log(message: string, ...args: unknown[]): void

Выводит сообщение.

Параметры:

• message (string) - сообщение для вывода
• args (unknown[]) - дополнительные аргументы для вывода

Пример:

runium.output.log("Log message", { detail: "value" })

success

success(message: string, ...args: unknown[]): void

Выводит сообщение об успехе.

Параметры:

• message (string) - сообщение для вывода
• args (unknown[]) - дополнительные аргументы для вывода

Пример:

runium.output.success("Success message", { detail: "value" })

table

table(data: unknown[], columns?: string[], options?: { order?: boolean }): void

Выводит данные в виде таблицы.

Параметры:

• data (unknown[]) - данные для вывода
• columns (string[], опционально) - названия колонок
• options (object, опционально) - опции вывода
  • order (boolean, опционально) - выводить столбец с порядковыми номерами

Пример:

runium.output.table(
  [
    { name: "Task 1", status: "running" },
    { name: "Task 2", status: "stopped" },
  ],
  ["name", "status"]
)

tree

tree(data: unknown, label?: string): void

Выводит данные в виде дерева.

Параметры:

• data (unknown) - объект для вывода
• label (string, опционально) - подпись для корневого элемента

Пример:

runium.output.tree(
  {
    name: "Project",
    prop1: false,
    prop2: {
      key1: "value",
      key2: [1, 2, 3],
    },
  },
  "Project"
)

divider

divider(char: string, length?: number): void

Выводит линию-разделитель.

Параметры:

• char (string) - символ для линии-разделителя
• length (number, опционально) - длина линии-разделителя

Пример:

runium.output.divider("-", 80)

box

box(text: string, color?: OutputStyle): void

Выводит текст в рамке.

Параметры:

• text (string) - текст для вывода в рамке
• color (string, опционально) - цвет рамки

Пример:

runium.output.box("Build completed")

spinner

spinner(status: () => boolean, text: string, completeText?: string): () => void

Показывает спиннер, пока функция status возвращает true.

Параметры:

• status (() => boolean) - функция, определяющая, должен ли спиннер продолжать работу
• text (string) - текст для отображения рядом со спиннером
• completeText (string, опционально) - текст после завершения спиннера

Возвращает: () => void - функция для остановки спиннера

Пример:

let running = true
runium.output.spinner(() => running, "Running task", "Task completed")

setTimeout(() => {
  running = false
}, 5000)

progress

progress(current: number, total: number, completeText?: string): void

Выводит индикатор прогресса.

Параметры:

• current (number) - текущее значение прогресса
• total (number) - общее значение прогресса
• completeText (string, опционально) - текст после завершения прогресса

Пример:

let i = 0
const iv = setInterval(() => {
  runium.output.progress(i, 50, "Half completed")
  if (++i > 50) clearInterval(iv)
}, 25)

writeStdout

writeStdout(message: string): void

Записывает сообщение в stdout.

Параметры:

• message (string) - сообщение для записи в stdout

Пример:

runium.output.writeStdout("stdout message")

writeStderr

writeStderr(message: string): void

Записывает сообщение в stderr.

Параметры:

• message (string) - сообщение для записи в stderr

Пример:

runium.output.writeStderr("stderr message")