Node.js v21.7.2 文档

os.EOL#

• <string>

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

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

os.availableParallelism()#

• 返回：<integer>

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

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

os.arch()#

• 返回：<string>

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

返回值等同于 process.arch。

os.constants#

• <Object>

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

os.cpus()#

• 返回：<Object[]>

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

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

• model <string>
• speed <number>（以 MHz 为单位）
• times <Object>
  • user <number> CPU 在用户模式下花费的毫秒数。
  • nice <number> CPU 在 nice 模式下花费的毫秒数。
  • sys <number> CPU 在 sys 模式下花费的毫秒数。
  • idle <number> CPU 在空闲模式下花费的毫秒数。
  • irq <number> CPU 在 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,
    },
  },
] copy

nice 值仅限于 POSIX。在 Windows 上，所有处理器的 nice 值始终为 0。

os.cpus().length 不应用于计算应用程序可用的并行量。为此，请使用 os.availableParallelism()。

os.devNull#

• <string>

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

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

os.endianness()#

• 返回：<string>

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

可能的值是 'BE'（大端字节序）和 'LE'（小端字节序）。

os.freemem()#

• 返回：<integer>

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

os.getPriority([pid])#

• pid <integer> 要检索其调度优先级的进程 ID。默认值：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、s390、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 作用域 ID（仅在 family 为 IPv6 时指定）
• cidr <string> 使用 CIDR 表示法分配的 IPv4 或 IPv6 地址和路由前缀。如果 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'
    }
  ]
} copy

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> 要为其设置调度优先级的进程 ID。默认值：0。
• priority <整数> 要分配给进程的调度优先级。

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

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

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

os.tmpdir()#

• 返回：<string>

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

os.totalmem()#

• 返回：<integer>

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

os.type()#

• 返回：<string>

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

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

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。

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

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

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 常量#