proglib/documentation/environment.md

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

# Environment
Предоставляет сведения о текущей среде и платформе, а также необходимые для управления ими средства.

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

## Свойства
```js
// Возвращает строку, обозначающую в данной среде начало новой строки.
// 
// Возврат:
//    String
Environment.NewLine;

// Возвращает имя пользователя, который на данный момент выполнил вход в операционную систему.
// 
// Возврат:
//    String
Environment.UserName;

// Возвращает имя NetBIOS данного локального компьютера.
// 
// Возврат:
//    String
Environment.MachineName;

// Возвращает имя сетевого домена, связанное с текущим пользователем.
// 
// Возврат:
//    String
Environment.UserDomainName;

// Папка профиля пользователя.
// 
// Возврат:
//    String
Environment.UserProfile;

// Возвращает или задаёт полный путь к текущей рабочей папке.
// 
// Возврат:
//    String
Environment.CurrentDirectory;

// Предоставляет информацию об операционной системе.
// 
// Возврат:
//    Object
Environment.OS;

// Возвращает версию Node.js в объекте Version.
// 
// Возврат:
//    Version
Environment.Version;

// Возвращает строку, которая определяет архитектуру CPU на данной ОС.
// 
// Возврат:
//    String
Environment.Architecture;

// Возвращает число процессоров на текущем компьютере.
// 
// Возврат:
//    Number
Environment.ProcessorCount;

// Возвращает время, истекшее с момента загрузки системы (в секундах).
// 
// Возврат:
//    Number
Environment.TickCount;

// Возвращает все количество системной памяти в байтах в виде целого числа.
// 
// Возврат:
//    Number
Environment.TotalMemory;

// Возвращает количество свободной системной памяти в байтах в виде целого числа.
// 
// Возврат:
//    Number
Environment.FreeMemory;

// Возвращает или задает код выхода из процесса.
// 
// Возврат:
//    Number
Environment.ExitCode;
```

## Методы
```js
// Возвращает путь к особой системной папке (Windows).
// 
// Параметры:
//    SpecialFolder
//       Константа, позволяющая определить особую системную папку.
// 
//    SpecialFolderOption
//       Задает параметры, используемые для получения пути к особой папке.
// 
// Возврат:
//    String
Environment.GetFolderPath(SpecialFolder, SpecialFolderOption = Environment.SpecialFolderOption.None);

// Возвращает строковый массив, содержащий аргументы командной строки для текущего процесса.
// 
// Возврат:
//    String
Environment.GetCommandLineArgs();

// Завершает этот процесс и возвращает внутренней операционной системе указанный код выхода.
// 
// Параметры:
//    ExitCode
//       Код выхода, возвращаемый операционной системе. Чтобы указать, что процесс прошел успешно, следует использовать 0.
Environment.Exit(ExitCode);

// Заставляет процесс Node.js немедленно закрываться с созданием core-файла.
Environment.Abort();
```

## Константы
```js
// Задает параметры, используемые для получения пути к особой папке.
// 
// Возврат:
//    Object
Environment.SpecialFolderOption;

// Указывает перечислимые константы, используемые для получения путей к системным особым папкам.
// 
// Возврат:
//    Object
Environment.SpecialFolder
```