proglib/documentation/operatingSystem.md

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

# OperatingSystem
Предоставляет информацию об операционной системе.

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

## Методы
```js
// Возвращает строку, которая определяет архитектуру CPU на данной ОС для которой компилируется бинарный Node.js.
// 
// Возврат:
//    String
static Architecture();

// Возвращает массив объектов, которые содержат информацию про каждый установленное ядро.
// 
// Возврат:
//    any[]
static CPUS();

// Возвращает строку, определяющую порядок байт CPU для которого скомпилирован бинарный Node.js.
// 
// Возврат:
//    String
static Endianness();

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

// Возвращает домашнюю директорию для текущего пользователя в виде строки.
// 
// Возврат:
//    String
static HomeDirectory();

//  Возвращает имя хоста операционной системы в в виде строки.
// 
// Возврат:
//    String
static HostName();

// Возвращает массив, содержащий средние значения нагрузки за 1, и 15 минут.
// Средняя нагрузка – это мера активности системы, вычисленная операционной системой и выраженная в виде дробного числа. Следуя правилу большого пальца, средняя нагрузка в идеале должна быть меньше, чем число логических CPU в системе.
// 
// Возврат:
//    Number[]
static LoadAvg();

// Возвращает объект, содержащий только сетевые интерфейсы, которые были назначены на адрес сети.
// Каждый ключ возвращаемого объекта указывает на сетевой интерфейс. Соответствующее ему значение является массивом объектов, каждый из которых описывает назначенный адрес сети.
// 
// Возврат:
//    Object
static NetworkInterfaces();

// Возвращает строку, показывающущю, какая платформа ОС была установлена во время компиляции Node.js.
// 
// Возврат:
//    String
static Platform();

// Возвращает строку, показывающую релиз операционной системы.
// 
// Возврат:
//    String
static Release();

// Возвращает строку, задающую операционную директорию по умолчанию для хранения временных файлов.
// 
// Возврат:
//    String
static TempPath();

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

// Возвращает строку, показывающую имя операционной системы.
// 
// Возврат:
//    String
static Type();

// Возвращает время безотказной работы системы в секундах.
// 
// Возврат:
//    Number
static TickCount();

// Возвращает информацию о текущем пользователе.
// 
// Возврат:
//    Object
static UserInfo();
```

## Констатны
```js
// Возвращает объект, содержащий общеиспользуемые константы операционнной системы для кодировки ошибок, сигналов процессов и тому подобное.
// 
// Возврат:
//    Object
OperatingSystem.constants;
```