Node.js v25.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 在系統模式下花費的毫秒數。
  • idle <number> CPU 在空閒模式下花費的毫秒數。
  • irq <number> CPU 在中斷請求模式下花費的毫秒數。

[
  {
    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 環境變數，則使用該變數。否則，它會使用有效使用者 ID 來查詢使用者的主目錄。

在 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 或為 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 常量#

以下常量由 os.constants 匯出。

並非所有常量在每個作業系統上都可用。