Node.js v25.0.0 ドキュメンテーション

os.EOL#

• 型: <string>

オペレーティングシステム固有の行末マーカーです。

• POSIX では \n
• Windows では \r\n

os.availableParallelism()#

• 戻り値: <integer>

プログラムが使用すべきデフォルトの並列処理量の推定値を返します。常に 0 より大きい値を返します。

この関数は、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 コアに関する情報を含むオブジェクトの配列を返します。/proc ファイルシステムが利用できないなど、CPU 情報が利用できない場合は、配列は空になります。

各オブジェクトに含まれるプロパティは以下の通りです。

• 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 が指定されないか 0 の場合、現在のプロセスの優先度が返されます。

os.homedir()#

• 戻り値: <string>

現在のユーザーのホームディレクトリの文字列パスを返します。

POSIX では、$HOME 環境変数が定義されていればそれを使用します。それ以外の場合は、実効 UID を使用してユーザーのホームディレクトリを検索します。

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 と同じです。

Node.js が Android オペレーティングシステム上でビルドされた場合、値 '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 内の 6 つの優先度定数のいずれかにマッピングされます。プロセスの優先度レベルを取得する際、この範囲マッピングにより 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 によってエクスポートされます。

すべての定数がすべてのオペレーティングシステムで利用可能というわけではありません。