操作系统

稳定性：2 - 稳定

node:os 模块提供与操作系统相关的实用方法和属性。可以使用以下方式访问：

import os from 'node:os';

• 类型：<string>

操作系统特定的行尾标记。

• \n 在 POSIX 上
• \r\n 在 Windows 上

os.availableParallelism(): void

• 返回值：<integer>

返回程序应使用的默认并行量的估计值。始终返回大于零的值。

此函数是 libuv 的 uv_available_parallelism() 的一个小包装。

os.arch(): void

• 返回值：<string>

返回编译 Node.js 二进制文件的操作系统的 CPU 架构。可能的值是 'arm'、'arm64'、'ia32'、'loong64'、'mips'、'mipsel'、'ppc64'、'riscv64'、's390x' 和 'x64'。

返回值等同于 process.arch。

• 类型：<Object>

包含常用的操作系统特定常量，用于错误代码、进程信号等。定义的具体常量在 操作系统常量 中描述。

os.cpus(): void

• 返回值：<Object[]>

返回一个对象数组，包含有关每个逻辑 CPU 核心的信息。如果无法获取 CPU 信息，例如 /proc 文件系统不可用，则数组将为空。

每个对象包含的属性包括：

[
  {
    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.cpus().length 不应被用于计算应用程序可用的并行量。为此请使用 os.availableParallelism()。

• 类型：<string>

特定平台的空设备文件路径。

• \\.\nul 在 Windows 上
• /dev/null 在 POSIX 上

os.endianness(): void

• 返回值：<string>

返回一个字符串，标识编译 Node.js 二进制文件的 CPU 的字节序。

可能的值是 'BE' 表示大端序，'LE' 表示小端序。

os.freemem(): void

• 返回值：<integer>

以整数形式返回空闲系统内存量（字节）。

os.getPriority(pid?): void

返回由 pid 指定的进程的调度优先级。如果未提供 pid 或为 0，则返回当前进程的优先级。

os.homedir(): void

• 返回值：<string>

返回当前用户主目录的字符串路径。

在 POSIX 上，如果定义了 $HOME 环境变量，则使用它。否则，它使用 有效 UID 查找用户的主目录。

在 Windows 上，如果定义了 USERPROFILE 环境变量，则使用它。否则，它使用当前用户的配置文件目录路径。

os.hostname(): void

• 返回值：<string>

以字符串形式返回操作系统的主机名。

os.loadavg(): void

• 返回值：<number[]>

返回一个包含 1 分钟、5 分钟和 15 分钟平均负载的数组。

平均负载是操作系统计算的系统活动度量，表示为分数。

平均负载是 Unix 特定的概念。在 Windows 上，返回值始终为 [0, 0, 0]。

os.machine(): void

• 返回值：<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(): void

• 返回值：<Object>

返回一个包含已分配网络地址的网络接口的对象。

返回对象上的每个键标识一个网络接口。关联的值是一个对象数组，每个对象描述一个分配的网络地址。

分配的网络地址对象上可用的属性包括：

{
  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(): void

• 返回值：<string>

返回一个字符串，标识编译 Node.js 二进制文件的操作系统平台。该值在编译时设置。可能的值是 'aix'、'darwin'、'freebsd'、'linux'、'openbsd'、'sunos' 和 'win32'。

返回值等同于 process.platform。

如果 Node.js 构建于 Android 操作系统上，也可能返回值 'android'。Android 支持是实验性的。

os.release(): void

• 返回值：<string>

以字符串形式返回操作系统版本。

在 POSIX 系统上，操作系统版本通过调用 uname(3) 确定。在 Windows 上，使用 GetVersionExW()。参见 https://en.wikipedia.org/wiki/Uname#Examples 获取更多信息。

os.setPriority(pid?, priority): void

尝试设置由 pid 指定的进程的调度优先级。如果未提供 pid 或为 0，则使用当前进程的进程 ID。

priority 输入必须是 -20（高优先级）到 19（低优先级）之间的整数。由于 Unix 优先级级别和 Windows 优先级类之间的差异，priority 被映射到 os.constants.priority 中的六个优先级常量之一。检索进程优先级级别时，此范围映射可能导致 Windows 上的返回值略有不同。为避免混淆，请将 priority 设置为优先级常量之一。

在 Windows 上，将优先级设置为 PRIORITY_HIGHEST 需要提升的用户权限。否则，设置的优先级将静默降低为 PRIORITY_HIGH。

os.tmpdir(): void

• 返回值：<string>

以字符串形式返回操作系统的临时文件默认目录。

在 Windows 上，结果可以被 TEMP 和 TMP 环境变量覆盖，且 TEMP 优先于 TMP。如果均未设置，则默认为 %SystemRoot%\temp 或 %windir%\temp。

在非 Windows 平台上，将检查 TMPDIR、TMP 和 TEMP 环境变量以覆盖此方法的结果，顺序如上所述。如果均未设置，则默认为 /tmp。

某些操作系统发行版会默认配置 TMPDIR（非 Windows）或 TEMP 和 TMP（Windows），而无需系统管理员进行额外配置。os.tmpdir() 的结果通常反映系统偏好，除非被用户显式覆盖。

os.totalmem(): void

• 返回：<integer>

以整数形式返回系统内存总量（字节）。

os.type(): void

• 返回：<string>

返回 uname(3) 提供的操作系统名称。例如，在 Linux 上返回 'Linux'，在 macOS 上返回 'Darwin'，在 Windows 上返回 'Windows_NT'。

有关在各种操作系统上运行 uname(3) 输出的更多信息，请参阅 https://en.wikipedia.org/wiki/Uname#Examples。

os.uptime(): void

• 返回：<integer>

返回系统正常运行时间（秒数）。

os.userInfo(options?): void

返回关于当前有效用户的信息。在 POSIX 平台上，这通常是密码文件的一个子集。返回的对象包括 username、uid、gid、shell 和 homedir。在 Windows 上，uid 和 gid 字段为 -1，shell 为 null。

os.userInfo() 返回的 homedir 值由操作系统提供。这与 os.homedir() 的结果不同，后者在回退到操作系统响应之前会查询环境变量以获取主目录。

如果用户没有 username 或 homedir，则抛出 SystemError。

os.version(): void

• 返回：<string>

返回标识内核版本的字符串。

在 POSIX 系统上，操作系统版本通过调用 uname(3) 确定。在 Windows 上，使用 RtlGetVersion()，如果不可用，则将使用 GetVersionExW()。有关更多信息，请参阅 https://en.wikipedia.org/wiki/Uname#Examples。

以下常量由 os.constants 导出。

并非所有常量在每个操作系统上都可用。

以下信号常量由 os.constants.signals 导出。

以下错误常量由 os.constants.errno 导出。

以下错误代码特定于 Windows 操作系统。

如果操作系统可用，以下常量导出在 os.constants.dlopen 中。有关详细信息，请参阅 dlopen(3)。

以下进程调度常量由 os.constants.priority 导出。