Node.js v18.18.2 文档

os.EOL#

• <字符串>

操作系统特定的行结束标记。

• POSIX 上的\n
• Windows 上的\r\n

os.availableParallelism()#

• 返回：<整数>

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

该函数是关于 libuv 的uv_available_parallelism()的小包装。

os.arch()#

• 返回：<字符串>

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

返回值相当于process.arch。

os.constants#

• <对象>

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

os.cpus()#

• 返回：<对象[]>

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

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

• model <字符串>
• speed <数字>（以 MHz 为单位）
• times <对象>
  • user <number> CPU 在用户模式下花费的毫秒数。
  • nice <number> CPU 在良好模式下花费的毫秒数。
  • 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#

• <字符串>

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

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

os.endianness()#

• 返回：<字符串>

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

对于大端，可能的值为'BE' ；对于小端，可能的值为'LE'。

os.freemem()#

• 返回：<整数>

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

os.getPriority([pid])#

• pid <integer>要检索其调度优先级的进程 ID。 默认值： 0。
• 返回：<整数>

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

os.homedir()#

• 返回：<字符串>

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

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

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

os.hostname()#

• 返回：<字符串>

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

os.loadavg()#

• 返回：<数字[]>

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

平均负载是操作系统计算的系统事件的度量，并表示为小数。

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

os.machine()#

• 返回<字符串>

以字符串形式返回机器类型，例如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()#

• 返回：<对象>

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

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

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

• 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>分配的 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'
    }
  ]
} copy

os.platform()#

• 返回：<字符串>

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

返回值相当于process.platform。

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

os.release()#

• 返回：<字符串>

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

在 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()#

• 返回：<字符串>

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

os.totalmem()#

• 返回：<整数>

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

os.type()#

• 返回：<字符串>

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

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

os.uptime()#

• 返回：<整数>

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

os.userInfo([options])#

• options <对象>
  • encoding <string>用于解释结果字符串的字符编码。如果encoding设置为'buffer'，则username、shell和homedir 值将为Buffer 默认值： 'utf8'。
• 返回：<对象>

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

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

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

os.version()#

• 返回<字符串>

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

在 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 常数#