Node.js v21.7.2 ドキュメント

os.EOL#

• <string>

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

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

os.availableParallelism()#

• 戻り値: <整数>

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

この関数は、libuvのuv_available_parallelism()に関する小さなラッパーです。

os.arch()#

• 戻り値: <string>

Node.jsバイナリがコンパイルされたオペレーティングシステムのCPUアーキテクチャを返します。可能な値は、'arm'、'arm64'、'ia32'、'loong64'、'mips'、'mipsel'、'ppc'、'ppc64'、'riscv64'、's390'、'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>

nullデバイスのプラットフォーム固有のファイルパス。

• Windowsでは\\.\nul
• POSIXでは/dev/null

os.endianness()#

• 戻り値: <string>

Node.jsバイナリがコンパイルされたCPUのエンディアンを識別する文字列を返します。

可能な値は、ビッグエンディアンの場合は'BE'、リトルエンディアンの場合は'LE'です。

os.freemem()#

• 戻り値: <整数>

使用可能なシステムメモリの量をバイト単位の整数として返します。

os.getPriority([pid])#

• pid <整数> スケジュール優先度を取得するプロセスID。デフォルト: 0。
• 戻り値: <整数>

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、s390、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 つの優先度定数の 1 つにマッピングされます。プロセスの優先度レベルを取得すると、この範囲マッピングにより、Windows で戻り値がわずかに異なる場合があります。混乱を避けるために、priority を優先度定数の 1 つに設定してください。

Windows では、優先度を PRIORITY_HIGHEST に設定するには、昇格されたユーザー権限が必要です。そうしないと、設定された優先度は PRIORITY_HIGH に静かに削減されます。

os.tmpdir()#

• 戻り値: <string>

一時ファイルのオペレーティングシステムのデフォルトディレクトリを文字列として返します。

os.totalmem()#

• 戻り値: <整数>

システムの総メモリ量をバイト単位の整数として返します。

os.type()#

• 戻り値: <string>

uname(3) によって返されるオペレーティングシステム名を返します。たとえば、Linux では 'Linux'、macOS では 'Darwin'、Windows では 'Windows_NT' を返します。

さまざまなオペレーティングシステムでの uname(3) の実行結果の詳細については、https://en.wikipedia.org/wiki/Uname#Examples を参照してください。

os.uptime()#

• 戻り値: <整数>

システム稼働時間を秒単位で返します。

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 によってエクスポートされます。

すべての定数がすべてのオペレーティングシステムで使用できるわけではありません。

シグナル定数#

次のシグナル定数は os.constants.signals によってエクスポートされます。

エラー定数#

以下のエラー定数は、os.constants.errno によってエクスポートされます。

POSIX エラー定数#

Windows 固有のエラー定数#

次のエラーコードは、Windows オペレーティングシステムに固有のものです。

dlopen 定数#

オペレーティングシステムで利用可能な場合、以下の定数は os.constants.dlopen でエクスポートされます。詳細については、dlopen(3) を参照してください。

優先度定数#

以下のプロセススケジューリング定数が os.constants.priority によってエクスポートされます。

libuv 定数#