Node.js v24.0.0 文档

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'、'ppc64'、'riscv64'、's390x' 和 'x64'。

返回值等效于 process.arch。

os.constants#

• <Object>

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

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 或 pid 为 0，则返回当前进程的优先级。

os.homedir()#

• 返回: <string>

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

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

在 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 作用域 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。

如果在 Android 操作系统上构建 Node.js，也可能返回 '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 <integer> 要分配给进程的调度优先级。

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

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。

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 导出。

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