proglib/documentation/io/path.md

Многофункциональная библиотека

# Path
Предоставляет изменяемую строку символов.

## Инициализация
```js
const IO = require('proglib').IO;
const Path = IO.Path;
```

## Свойства
```js
// Предоставляет символ, для разделения уровней папок в строке пути, в которой отражена иерархическая организация файловой системы.
// 
// Возврат:
//    String
Path.DirectorySeparatorChar;

// Предоставляет дополнительный символ, для разделения уровней каталогов в строке пути, в которой отражена иерархическая организация файловой системы.
// 
// Возврат:
//    String
Path.AltDirectorySeparatorChar;

// Предоставляет разделитель томов.
// 
// Возврат:
//    String
Path.VolumeSeparatorChar;

// Предоставляет массив символов, которые не могут быть указаны в аргументах строки пути, передаваемых в элементы класса Path.
// 
// Возврат:
//    String[]
Path.InvalidPathChars;

// Разделитель, который используется в переменных среды для разделения строк пути.
// 
// Возврат:
//    String
Path.PathSeparator;
```

## Методы
```js
// Определяет, содежит ли путь запрещённые символы.
// 
// Параметры:
//    Path
//       Проверяемая строка пути.
// 
// Возврат:
//    Boolean
Path.CheckInvalidPathChars(Path);

// Определяет, имеет ли путь недопустимую форму.
// 
// Параметры:
//    Path
//       Проверяемая строка пути.
// 
// Возврат:
//    Boolean
Path.CheckNormalPath(Path);

// Изменяет расширение строки пути.
// 
// Параметры:
//    Path
//       Сведения о пути, которые нужно изменить.
// 
//    Extension
//       Новое расширение (начинающееся с точки или без нее). Задает null для удаления существующего расширения из параметра Path.
// 
// Возврат:
//    String
Path.ChangeExtension(Path, Extension);

// Объединяет массив строк в путь.
// 
// Параметры:
//    Paths
//       Массив частей пути.
// 
// Возврат:
//    String
Path.Combine(...Paths);

// Объединяет все данные сегменты пути вместе, используя для этого заданный платформенный разделитель, и приводит полученный путь к нормальному виду.
// 
// Параметры:
//    Paths
//       Массив частей пути.
// 
// Возврат:
//    String
Path.Join(...Paths);

// Возвращает объект, чьи свойства представляют собой важные элементы пути.
// 
// Параметры:
//    Path
//       Проверяемый путь.
// 
// Возврат:
//    Object
Path.Parse(Path);

// Нормализует данный путь, распределяя сегменты '..' и '.'.
// 
// Параметры:
//    Path
//       Путь, который требуется нормализовать.
// 
// Возврат:
//    String
Path.Normalize(Path);

// Возвращает приблизительный путь из From в To.
// Если From и To приводят к одному и тому же пути (после вызова Path.Resolve() для обоих), возвращается строка с нулевой длиной.
// 
// Параметры:
//    From
// 
//    To
// 
// Возврат:
//    String
Path.Relative(From, To);

// Превращает последовательность путей или сегментов пути в абсолютный путь.
// 
// Параметры:
//    Paths
//       Последовательность путей.
// 
// Возврат:
//    String
Path.Resolve(...Paths);

// Возвращает для указанной строки пути сведения о каталоге.
// 
// Параметры:
//    Path
//       Путь к файлу или каталогу.
// 
// Возврат:
//    String
Path.GetDirectoryName(Path);

// Возвращает расширение указанной строки пути.
// 
// Параметры:
//    Path
//       Строка пути, из которой нужно получить расширение.
// 
// Возврат:
//    String
Path.GetExtension(Path);

// Возвращает имя файла и расширение указанной строки пути.
// 
// Параметры:
//    Path
//       Строка пути, из которой нужно получить имя файла и расширение.
// 
// Возврат:
//    String
Path.GetFileName(Path);

// Возвращает имя файла указанной строки пути без расширения.
// 
// Параметры:
//    Path
//       Путь к файлу.
// 
// Возврат:
//    String
Path.GetFileNameWithoutExtension(Path);

// Возвращает для указанной строки пути абсолютный путь.
// 
// Параметры:
//    Path
//       Файл или каталог, для которых нужно получить сведения об абсолютном пути.
// 
// Возврат:
//    String
Path.GetFullPath(Path);

// Возвращает массив, содержащий символы, которые не разрешены в именах файлов.
// 
// Возврат:
//    String[]
Path.GetInvalidFileNameChars();

// Возвращает массив, содержащий символы, которые не разрешены в именах путей.
// 
// Возврат:
//    String[]
Path.GetInvalidPathChars();

// Возвращает произвольное имя каталога.
// 
// Возврат:
//    String
Path.GetRandomDirectoryName();

// Возвращает произвольное имя файла.
// 
// Возврат:
//    String
Path.GetRandomFileName();

// Возвращает сведения о корневом каталоге для указанного пути.
// 
// Параметры:
//    Path
//       Путь, из которого нужно получить сведения о корневом каталоге.
// 
// Возврат:
//    String
Path.GetPathRoot(Path);

// Возвращает путь к временной папке текущего пользователя.
// 
// Возврат:
//    String
Path.GetTempPath();

// Определяет, включает ли путь расширение имени файла.
// 
// Параметры:
//    Path
//       Путь для поиска расширения.
// 
// Возврат:
//    String
Path.HasExtension(Path);

// Определяет, является ли Path абсолютным путем.
// 
// Параметры:
//    Path
//       Проверяемый путь.
// 
// Возврат:
//    String
Path.IsAbsolute(Path);

// Возвращает значение, указывающее, содержит ли заданный путь корневую папку.
// 
// Параметры:
//    Path
//       Проверяемый путь.
// 
// Возврат:
//    String
Path.IsPathRooted(Path);

// Определяет, существует ли заданный файл или каталог.
// 
// Параметры:
//    Path
//       Проверяемый путь.
// 
// Возврат:
//    String
Path.Exists(Path);
```