OS

Исходный код: lib/os.js

Модуль os предоставляет служебные методы и свойства, связанные с операционной системой. К нему можно получить доступ с помощью:

const os = require('os');

os.EOL

• <строка>

Маркер конца строки, специфичный для операционной системы.

• \n на POSIX
• \r\n на Windows

os.arch()

• Возвращает: <строка>

Возвращает архитектуру процессора операционной системы, для которой скомпилирован двоичный файл Node.js. Возможные значения: 'arm', 'arm64', 'ia32', 'mips', 'mipsel', 'ppc', 'ppc64', 's390', 's390x', 'x32', и 'x64'.

Возвращаемое значение эквивалентно process.arch.

os.constants

• <Объект>

Содержит часто используемые константы, специфичные для операционной системы, для кодов ошибок, сигналов процессов и т. д. Конкретные определенные константы описаны в константах OS.

os.cpus()

• Возвращает: <Массив объектов>

Возвращает массив объектов, содержащих информацию о каждом логическом ядре процессора.

Свойства каждого объекта включают:

• model <строка>
• speed <число> (в МГц)
• times <объект>
  • user <число> Количество миллисекунд, затраченных процессором в пользовательском режиме.
  • nice <число> Количество миллисекунд, затраченных процессором в режиме nice.
  • sys <число> Количество миллисекунд, затраченных процессором в режиме sys.
  • idle <число> Количество миллисекунд, затраченных процессором в режиме простоя.
  • irq <число> Количество миллисекунд, затраченных процессором в режиме irq.

[
  {
    model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times: {
      user: 252020,
      nice: 0,
      sys: 30340,
      idle: 1070356870,
      irq: 0
    }
  },
  {
    model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times: {
      user: 306960,
      nice: 0,
      sys: 26980,
      idle: 1071569080,
      irq: 0
    }
  },
  {
    model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times: {
      user: 248450,
      nice: 0,
      sys: 21750,
      idle: 1070919370,
      irq: 0
    }
  },
  {
    model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times: {
      user: 256880,
      nice: 0,
      sys: 19430,
      idle: 1070905480,
      irq: 20
    }
  }
]

Значения nice доступны только на POSIX. В Windows значения nice всех процессоров всегда равны 0.

os.endianness()

• Возвращает: <строка>

Возвращает строку, определяющую порядок байтов процессора, для которого был скомпилирован двоичный файл Node.js.

Возможные значения: 'BE' для big endian и 'LE' для little endian.

os.freemem()

• Возвращает: <целое>

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

os.getPriority([pid])

• pid <целое> Идентификатор процесса, для которого необходимо получить приоритет планирования. По умолчанию 0.
• Возвращает: <целое>

Возвращает приоритет планирования для процесса, указанного по pid. Если pid не указано или равно 0, возвращается приоритет текущего процесса.

os.homedir()

• Возвращает: <строка>

Возвращает строковый путь к домашнему каталогу текущего пользователя.

На POSIX, использует переменную окружения $HOME если она определена. В противном случае используется эффективный UID для поиска домашнего каталога пользователя.

В Windows, использует переменную окружения USERPROFILE если она определена. В противном случае используется путь к каталогу профиля текущего пользователя.

os.hostname()

• Возвращает: <строка>

Возвращает имя хоста операционной системы в виде строки.

os.loadavg()

• Возвращает: <массив чисел>

Возвращает массив, содержащий средние значения загрузки за 1, 5 и 15 минут.

Среднее значение загрузки — это показатель активности системы, вычисленный операционной системой и выраженный в виде дробного числа.

Среднее значение загрузки — это понятие, специфичное для Unix. В Windows возвращаемое значение всегда [0, 0, 0].

os.networkInterfaces()

• Возвращает: <объект>

Возвращает объект, содержащий сетевые интерфейсы, которым назначен сетевой адрес.

Каждый ключ в возвращаемом объекте идентифицирует сетевой интерфейс. Соответствующее значение — массив объектов, каждый из которых описывает назначенный сетевой адрес.

Свойства объекта назначенного сетевого адреса включают:

• address <строка> Назначенный IPv4 или IPv6 адрес
• netmask <строка> IPv4 или IPv6 сетевая маска
• family <строка> Либо IPv4 или IPv6
• mac <строка> MAC-адрес сетевого интерфейса
• internal <логическое значение> true если сетевой интерфейс — интерфейс петли обратной связи или подобный интерфейс, недоступный удаленно; в противном случае false
• scopeid <число> Числовой идентификатор IPv6 области (указывается только когда family равно IPv6)
• cidr <строка> Назначенный IPv4 или IPv6 адрес с префиксом маршрутизации в CIDR-нотации. Если netmask некорректен, это свойство устанавливается в null.

{
  lo: [
    {
      address: '127.0.0.1',
      netmask: '255.0.0.0',
      family: 'IPv4',
      mac: '00:00:00:00:00:00',
      internal: true,
      cidr: '127.0.0.1/8'
    },
    {
      address: '::1',
      netmask: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff',
      family: 'IPv6',
      mac: '00:00:00:00:00:00',
      scopeid: 0,
      internal: true,
      cidr: '::1/128'
    }
  ],
  eth0: [
    {
      address: '192.168.1.108',
      netmask: '255.255.255.0',
      family: 'IPv4',
      mac: '01:02:03:0a:0b:0c',
      internal: false,
      cidr: '192.168.1.108/24'
    },
    {
      address: 'fe80::a00:27ff:fe4e:66a1',
      netmask: 'ffff:ffff:ffff:ffff::',
      family: 'IPv6',
      mac: '01:02:03:0a:0b:0c',
      scopeid: 1,
      internal: false,
      cidr: 'fe80::a00:27ff:fe4e:66a1/64'
    }
  ]
}

os.platform()

• Возвращает: <строка>

Возвращает строку, определяющую платформу операционной системы. Значение устанавливается во время компиляции. Возможные значения: 'aix', 'darwin', 'freebsd', 'linux', 'openbsd', 'sunos', и 'win32'.

Возвращаемое значение эквивалентно process.platform.

Значение 'android' также может быть возвращено, если Node.js построен на операционной системе Android. Поддержка Android экспериментальная.

os.release()

• Возвращает: <строка>

Возвращает операционную систему в виде строки.

В системах POSIX выпуск операционной системы определяется вызовом uname(3). В Windows используется GetVersionExW(). Дополнительную информацию см. в https://en.wikipedia.org/wiki/Uname#Examples.

os.setPriority([pid, ]priority)

• pid <целое> Идентификатор процесса, для которого необходимо установить приоритет планирования. По умолчанию 0.
• priority <целое> Приоритет планирования, который нужно назначить процессу.

Попытка установить приоритет планирования для процесса, указанного по pid. Если pid не указано или равно 0, используется идентификатор процесса текущего процесса.

Значение priority должно быть целым числом в диапазоне от -20 (высокий приоритет) до 19 (низкий приоритет). Из-за различий между уровнями приоритета Unix и классами приоритета Windows, priority сопоставляется с одним из шести констант приоритета в os.constants.priority. При получении уровня приоритета процесса это сопоставление диапазонов может привести к тому, что возвращаемое значение будет немного отличаться в Windows. Чтобы избежать путаницы, установите priority в одну из констант приоритета.

В Windows, для установки приоритета PRIORITY_HIGHEST требуются повышенные права пользователя. В противном случае установленный приоритет будет тихо уменьшен до PRIORITY_HIGH.

os.tmpdir()

• Возвращает: <строка>

Возвращает стандартный каталог операционной системы для временных файлов в виде строки.

os.totalmem()

• Возвращает: <целое число>

Возвращает общий объем оперативной памяти в байтах в виде целого числа.

os.type()

• Возвращает: <строка>

Возвращает имя операционной системы, как возвращается функцией uname(3). Например, возвращает 'Linux' в Linux, 'Darwin' в macOS и 'Windows_NT' в Windows.

См. https://en.wikipedia.org/wiki/Uname#Examples для дополнительной информации о выводе выполнения uname(3) на различных операционных системах.

os.uptime()

• Возвращает: <целое число>

Возвращает время активности системы в секундах.

os.userInfo([options])

• options <Объект>
  • encoding <строка> Кодировка символов, используемая для интерпретации результирующих строк. Если encoding установлено в 'buffer', то значения username, shell, и homedir будут экземплярами Buffer. По умолчанию: 'utf8'.
• Возвращает: <Объект>

Возвращает информацию о текущем эффективном пользователе. На платформах POSIX это обычно подмножество файла паролей. Возвращаемый объект включает поля username, uid, gid, shell, и homedir. В Windows поля uid и gid имеют значения -1, а поле shell равно null.

Значение homedir, возвращаемое функцией os.userInfo(), предоставляется операционной системой. Это отличается от результата os.homedir(), который запрашивает переменные среды для домашнего каталога перед использованием ответа операционной системы.

Выбрасывает исключение SystemError, если у пользователя нет username или homedir.

os.version()

• Возвращает <строку>

Возвращает строку, идентифицирующую версию ядра.

В системах POSIX версия операционной системы определяется с помощью вызова uname(3). В Windows используется RtlGetVersion(), а если она недоступна, используется GetVersionExW(). См. https://en.wikipedia.org/wiki/Uname#Examples для получения дополнительной информации.

Константы ОС

Следующие константы экспортируются os.constants.

Не все константы будут доступны на каждой операционной системе.

Константы сигналов

Следующие константы сигналов экспортируются os.constants.signals.

Константы ошибок

Следующие константы ошибок экспортируются os.constants.errno.

Константы ошибок POSIX

Ошибки, специфичные для Windows

Следующие коды ошибок специфичны для операционной системы Windows.

dlopen constants

Если доступно в операционной системе, следующие константы экспортируются в os.constants.dlopen. Подробная информация приведена в dlopen(3).

Priority constants

Следующие константы планирования процессов экспортируются os.constants.priority.

libuv constants