ОС

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

import os from 'node:os';

const os = require('node:os');

os.EOL

• Тип: <string>

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

• \n в POSIX
• \r\n в Windows

os.availableParallelism()

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

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

Эта функция представляет собой небольшую обёртку над uv_available_parallelism() из libuv.

os.arch()

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

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

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

os.constants

• Тип: <Object>

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

os.cpus()

• Возвращает: <Object[]>

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

Каждый объект содержит следующие свойства:

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

[
  {
    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,
    },
  },
];
jscopy

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

Не следует использовать os.cpus().length для вычисления доступного приложению уровня параллелизма. Для этой цели используйте os.availableParallelism().

os.devNull

• Тип: <string>

Специфичный для платформы путь к файлу нулевого устройства.

• \\.\nul в Windows
• /dev/null в POSIX

os.endianness()

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

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

Возможные значения: 'BE' для порядка от старшего байта к младшему и 'LE' для порядка от младшего байта к старшему.

os.freemem()

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

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

os.getPriority([pid])

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

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

os.homedir()

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

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

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

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

os.hostname()

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

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

os.loadavg()

• Возвращает: <number[]>

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

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

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

os.machine()

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

Возвращает тип компьютера в виде строки, например arm, arm64, aarch64, mips, mips64, ppc64, ppc64le, s390x, i386, i686, x86_64.

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

os.networkInterfaces()

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

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

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

Объект назначенного сетевого адреса содержит следующие свойства:

• address <string> Назначенный адрес IPv4 или IPv6
• netmask <string> Сетевая маска IPv4 или IPv6
• family <string> IPv4 или IPv6
• mac <string> MAC-адрес сетевого интерфейса
• internal <boolean> true, если сетевой интерфейс является петлевым или аналогичным интерфейсом, недоступным извне; в противном случае — false
• scopeid <number> Числовой идентификатор области IPv6 (указывается только если family равно IPv6)
• cidr <string> Назначенный адрес 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"
    }
  ]
}
jsoncopy

os.platform()

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

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

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

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

os.release()

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

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

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

os.setPriority([pid, ]priority)

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

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

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

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

os.tmpdir()

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

Возвращает строку с путём к каталогу временных файлов, используемому операционной системой по умолчанию.

В Windows результат можно переопределить с помощью переменных окружения TEMP и TMP; TEMP имеет приоритет над TMP. Если ни одна из них не задана, по умолчанию используется %SystemRoot%\temp или %windir%\temp.

На платформах, отличных от Windows, проверяются переменные окружения TMPDIR, TMP и TEMP, переопределяющие результат этого метода, в указанном порядке. Если ни одна из них не задана, по умолчанию используется /tmp.

Некоторые дистрибутивы операционных систем по умолчанию настраивают TMPDIR (не Windows) или TEMP и TMP (Windows) без дополнительных действий системных администраторов. Результат os.tmpdir() обычно отражает системные настройки, если только пользователи явно не переопределили их.

os.totalmem()

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

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

os.type()

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

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

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

os.uptime()

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

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

os.userInfo([options])

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

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

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

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

os.version()

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

Возвращает строку, определяющую версию ядра.

В 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

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

Константы приоритета

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

Константы libuv