Тема
GlobalRuniumUtils
Утилитарные функции для работы с макросами, путями и ошибками.
Методы
| Наименование | Описание |
|---|---|
| applyMacros | Применить макросы к текстовой строке |
| isRuniumError | Проверить, является ли ошибка RuniumError |
| pathToId | Преобразовать путь в формат идентификатора |
Описание методов
applyMacros
typescript
applyMacros(text: string, macros: MacrosCollection): stringПрименяет макросы к текстовой строке.
Параметры:
text(string) - текстовая строка для применения макросовmacros(MacrosCollection) - коллекция макросов для применения
Возвращает: string - строка с примененными макросами
Пример:
typescript
const macros = {
someMacro: () => "some-value",
}
const result = runium.utils.applyMacros("Building $someMacro()", macros)
// result: "Building some-value"isRuniumError
typescript
isRuniumError(error: unknown): booleanПроверяет, является ли ошибка экземпляром RuniumError.
Параметры:
error(unknown) - ошибка для проверки
Возвращает: boolean - true, если ошибка является RuniumError
Пример:
typescript
try {
// некоторый код
} catch (error) {
if (runium.utils.isRuniumError(error)) {
runium.output.error("Runium error occurred:", error.message)
} else {
runium.output.error("Unknown error:", error)
}
}pathToId
typescript
pathToId(path: string): stringПреобразует путь в формат идентификатора.
Параметры:
path(string) - путь для преобразования
Возвращает: string - идентификатор
Пример:
typescript
const id = runium.utils.pathToId("/path/to/project")
// id: "path-to-project"