Node.js v25.3.0 文档

os.EOL#>

• 类型：<string>

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

【The operating system-specific end-of-line marker.】

• 在 POSIX 上
• 在 Windows 上

os.availableParallelism()#>

• 返回：<integer>

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

【Returns an estimate of the default amount of parallelism a program should use. Always returns a value greater than zero.】

这个函数是关于 libuv 的 uv_available_parallelism() 的一个小封装。

【This function is a small wrapper about libuv's uv_available_parallelism().】

os.arch()#>

• 返回：<string>

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

【Returns the operating system CPU architecture for which the Node.js binary was compiled. Possible values are 'arm', 'arm64', 'ia32', 'loong64', 'mips', 'mipsel', 'ppc64', 'riscv64', 's390x', and 'x64'.】

返回值等同于 process.arch。

【The return value is equivalent to process.arch.】

os.constants#>

• 类型: <Object>

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

【Contains commonly used operating system-specific constants for error codes, process signals, and so on. The specific constants defined are described in OS constants.】

os.cpus()#>

• 返回：对象[]

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

【Returns an array of objects containing information about each logical CPU core. The array will be empty if no CPU information is available, such as if the /proc file system is unavailable.】

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

【The properties included on each object include:】

• model <string>
• speed <number>（兆赫）
• times <Object>
  • user <number> CPU 在用户模式下花费的毫秒数。
  • nice <number> CPU花费在nice模式下的毫秒数。
  • sys <number> CPU 在系统模式下运行的毫秒数。
  • 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,
    },
  },
] 拷贝

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

不应使用 os.cpus().length 来计算应用可用的并行数量。应使用 os.availableParallelism() 来实现此目的。

os.devNull#>

• 类型：<string>

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

【The platform-specific file path of the null device.】

• \. ul 在 Windows 上
• POSIX 系统上的 /dev/null

os.endianness()#>

• 返回：<string>

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

【Returns a string identifying the endianness of the CPU for which the Node.js binary was compiled.】

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

【Possible values are 'BE' for big endian and 'LE' for little endian.】

os.freemem()#>

• 返回：<integer>

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

【Returns the amount of free system memory in bytes as an integer.】

os.getPriority([pid])#>

• pid <integer> 要获取调度优先级的进程 ID。 默认值： 0。
• 返回：<integer>

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

【Returns the scheduling priority for the process specified by pid. If pid is not provided or is 0, the priority of the current process is returned.】

os.homedir()#>

• 返回：<string>

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

【Returns the string path of the current user's home directory.】

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

【On POSIX, it uses the $HOME environment variable if defined. Otherwise it uses the effective UID to look up the user's home directory.】

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

【On Windows, it uses the USERPROFILE environment variable if defined. Otherwise it uses the path to the profile directory of the current user.】

os.hostname()#>

• 返回：<string>

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

【Returns the host name of the operating system as a string.】

os.loadavg()#>

• 返回次数：编号[]

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

【Returns an array containing the 1, 5, and 15 minute load averages.】

负载平均值是操作系统计算的系统活动的度量，并以小数形式表示。

【The load average is a measure of system activity calculated by the operating system and expressed as a fractional number.】

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

【The load average is a Unix-specific concept. On Windows, the return value is always [0, 0, 0].】

os.machine()#>

• 返回：<string>

返回机器类型的字符串，例如 arm、arm64、aarch64、mips、mips64、ppc64、ppc64le、s390x、i386、i686、x86_64。

【Returns the machine type as a string, such as 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>

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

【Returns an object containing network interfaces that have been assigned a network address.】

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

【Each key on the returned object identifies a network interface. The associated value is an array of objects that each describe an assigned network address.】

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

【The properties available on the assigned network address object include:】

• 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'
    }
  ]
} 拷贝

os.platform()#>

• 返回：<string>

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

【Returns a string identifying the operating system platform for which the Node.js binary was compiled. The value is set at compile time. Possible values are 'aix', 'darwin', 'freebsd','linux', 'openbsd', 'sunos', and 'win32'.】

返回值等同于 process.platform。

【The return value is equivalent to process.platform.】

如果 Node.js 构建在 Android 操作系统上，也可能返回值 'android'。Android 支持处于试验阶段。

【The value 'android' may also be returned if Node.js is built on the Android operating system. Android support is experimental.】

os.release()#>

• 返回：<string>

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

【Returns the operating system as a 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。

【Attempts to set the scheduling priority for the process specified by pid. If pid is not provided or is 0, the process ID of the current process is used.】

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

【The priority input must be an integer between -20 (high priority) and 19 (low priority). Due to differences between Unix priority levels and Windows priority classes, priority is mapped to one of six priority constants in os.constants.priority. When retrieving a process priority level, this range mapping may cause the return value to be slightly different on Windows. To avoid confusion, set priority to one of the priority constants.】

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

【On Windows, setting priority to PRIORITY_HIGHEST requires elevated user privileges. Otherwise the set priority will be silently reduced to PRIORITY_HIGH.】

os.tmpdir()#>

• 返回：<string>

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

【Returns the operating system's default directory for temporary files as a string.】

在 Windows 上，结果可以通过 TEMP 和 TMP 环境变量来覆盖，其中 TEMP 优先于 TMP。如果两者都未设置，则默认为 %SystemRoot%\temp 或 %windir%\temp。

【On Windows, the result can be overridden by TEMP and TMP environment variables, and TEMP takes precedence over TMP. If neither is set, it defaults to %SystemRoot%\temp or %windir%\temp.】

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

【On non-Windows platforms, TMPDIR, TMP and TEMP environment variables will be checked to override the result of this method, in the described order. If none of them is set, it defaults to /tmp.】

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

【Some operating system distributions would either configure TMPDIR (non-Windows) or TEMP and TMP (Windows) by default without additional configurations by the system administrators. The result of os.tmpdir() typically reflects the system preference unless it's explicitly overridden by the users.】

os.totalmem()#>

• 返回：<integer>

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

【Returns the total amount of system memory in bytes as an integer.】

os.type()#>

• 返回：<string>

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

【Returns the operating system name as returned by uname(3). For example, it returns 'Linux' on Linux, 'Darwin' on macOS, and 'Windows_NT' on Windows.】

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

os.uptime()#>

• 返回：<integer>

以秒为单位返回系统正常运行时间。

【Returns the system uptime in number of seconds.】

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。

【Returns information about the currently effective user. On POSIX platforms, this is typically a subset of the password file. The returned object includes the username, uid, gid, shell, and homedir. On Windows, the uid and gid fields are -1, and shell is null.】

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

【The value of homedir returned by os.userInfo() is provided by the operating system. This differs from the result of os.homedir(), which queries environment variables for the home directory before falling back to the operating system response.】

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

【Throws a SystemError if a user has no username or homedir.】

os.version()#>

• 返回：<string>

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

【Returns a string identifying the kernel version.】

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

操作系统常量#>

【OS constants】

os.constants 导出了以下常量。

【The following constants are exported by os.constants.】

并非所有常量都适用于每个操作系统。

【Not all constants will be available on every operating system.】

信号常量#>

【Signal constants】

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

【The following signal constants are exported by os.constants.signals.】

错误常量#>

【Error constants】

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

【The following error constants are exported by os.constants.errno.】

POSIX 错误常量#>

【POSIX error constants】

Windows 特定的错误常量#>

【Windows-specific error constants】

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

【The following error codes are specific to the Windows operating system.】

dlopen 常量#>

【dlopen constants】

如果操作系统支持，以下常量会在 os.constants.dlopen 中导出。详细信息请参见 dlopen(3)。

【If available on the operating system, the following constants are exported in os.constants.dlopen. See dlopen(3) for detailed information.】

优先级常量#>

【Priority constants】

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

【The following process scheduling constants are exported by os.constants.priority.】

libuv 常量#>

【libuv constants】