Node.js v21.7.2 文件

os.EOL#

• <字串>

作業系統特定的行尾標記。

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

os.availableParallelism()#

• 傳回：<整數>

傳回程式應使用的預設平行度估計值。總是傳回大於 0 的值。

此函式是 libuv 的 uv_available_parallelism() 的小包裝器。

os.arch()#

• 回傳值：<字串>

回傳編譯 Node.js 二進位檔所使用的作業系統 CPU 架構。可能的值為 'arm'、'arm64'、'ia32'、'loong64'、'mips'、'mipsel'、'ppc'、'ppc64'、'riscv64'、's390'、's390x' 和 'x64'。

回傳值等同於 process.arch。

os.constants#

• <物件>

包含作業系統特定的常數，例如錯誤代碼、處理程序訊號等。定義的特定常數說明於 作業系統常數。

os.cpus()#

• 回傳值：<物件陣列>

回傳包含每個邏輯 CPU 核心資訊的物件陣列。如果沒有 CPU 資訊（例如無法使用 /proc 檔案系統），陣列會是空的。

每個物件包含的屬性包括

• model <字串>
• speed <數字>（單位為 MHz）
• times <Object>
  • user <number> CPU 在使用者模式下花費的毫秒數。
  • nice <number> CPU 在 nice 模式下花費的毫秒數。
  • sys <number> CPU 在 sys 模式下花費的毫秒數。
  • idle <number> CPU 在 idle 模式下花費的毫秒數。
  • 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()#

• 傳回：<number[]>

傳回包含 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 <字串> 已指定的 IPv4 或 IPv6 位址
• netmask <字串> IPv4 或 IPv6 網路遮罩
• family <字串> IPv4 或 IPv6
• mac <字串> 網路介面的 MAC 位址
• internal <布林> 如果網路介面是迴圈或類似介面，且無法遠端存取，則為 true；否則為 false
• scopeid <數字> 數值 IPv6 範圍 ID（僅在 family 為 IPv6 時指定）
• cidr <字串> 已指派的 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 <整數> 設定排程優先順序的處理序 ID。預設值：0。
• priority <整數> 要指派給處理序的排程優先順序。

嘗試設定由 pid 指定的程序排程優先順序。如果未提供 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'。

請參閱 https://en.wikipedia.org/wiki/Uname#Examples，以取得更多關於在各種作業系統上執行 uname(3) 的輸出資訊。

os.uptime()#

• 傳回：<整數>

傳回系統正常執行時間（以秒為單位）。

os.userInfo([options])#

• options <Object>
  • 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 常數#