Node.js v26.0.0 Dokumentation

OS#

Das node:os Modul stellt betriebssystembezogene Dienstmethoden und -eigenschaften bereit. Es kann aufgerufen werden mit

import os from 'node:os';
const os = require('node:os');
copy

os.EOL#

• Typ: <string>

Das betriebssystemspezifische Zeilenumbruchzeichen.

• \n unter POSIX
• \r\n unter Windows

os.availableParallelism()#

• Gibt zurück: <integer>

Gibt eine Schätzung des Standard-Parallelitätsgrads zurück, den ein Programm verwenden sollte. Gibt immer einen Wert größer als null zurück.

Diese Funktion ist ein kleiner Wrapper um libuvs uv_available_parallelism().

os.arch()#

• Rückgabe: <string>

Gibt die CPU-Architektur des Betriebssystems zurück, für die das Node.js-Binary kompiliert wurde. Mögliche Werte sind 'arm', 'arm64', 'ia32', 'loong64', 'mips', 'mipsel', 'ppc64', 'riscv64', 's390x' und 'x64'.

Der Rückgabewert entspricht process.arch.

os.constants#

• Typ: <Object>

Enthält häufig verwendete betriebssystemspezifische Konstanten für Fehlercodes, Prozesssignale usw. Die definierten Konstanten sind unter OS-Konstanten beschrieben.

os.cpus()#

• Gibt zurück: <Object[]>

Gibt ein Array von Objekten zurück, die Informationen über jeden logischen CPU-Kern enthalten. Das Array ist leer, wenn keine CPU-Informationen verfügbar sind, z. B. wenn das /proc Dateisystem nicht verfügbar ist.

Die in jedem Objekt enthaltenen Eigenschaften umfassen

• model <string>
• speed <number> (in MHz)
• times <Object>
  • user <number> Die Anzahl der Millisekunden, die die CPU im Benutzermodus verbracht hat.
  • nice <number> Die Anzahl der Millisekunden, die die CPU im nice-Modus verbracht hat.
  • sys <number> Die Anzahl der Millisekunden, die die CPU im Systemmodus verbracht hat.
  • idle <number> Die Anzahl der Millisekunden, die die CPU im Leerlaufmodus verbracht hat.
  • irq <number> Die Anzahl der Millisekunden, die die CPU im Interrupt-Modus verbracht hat.

[
  {
    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-Werte sind POSIX-spezifisch. Unter Windows sind die nice-Werte aller Prozessoren immer 0.

os.cpus().length sollte nicht verwendet werden, um den für eine Anwendung verfügbaren Parallelitätsgrad zu berechnen. Verwenden Sie os.availableParallelism() zu diesem Zweck.

os.devNull#

• Typ: <string>

Der plattformspezifische Dateipfad des Null-Geräts.

• \\.\nul unter Windows
• /dev/null unter POSIX

os.endianness()#

• Rückgabe: <string>

Gibt einen String zurück, der die Endianness der CPU angibt, für die das Node.js-Binary kompiliert wurde.

Mögliche Werte sind 'BE' für Big-Endian und 'LE' für Little-Endian.

os.freemem()#

• Gibt zurück: <integer>

Gibt die Menge des freien Systemspeichers in Bytes als Integer zurück.

os.getPriority([pid])#

• pid <integer> Die Prozess-ID, für die die Planpriorität abgerufen werden soll. Standard: 0.
• Gibt zurück: <integer>

Gibt die Planpriorität für den durch pid angegebenen Prozess zurück. Wenn pid nicht angegeben oder 0 ist, wird die Priorität des aktuellen Prozesses zurückgegeben.

os.homedir()#

• Rückgabe: <string>

Gibt den String-Pfad des Home-Verzeichnisses des aktuellen Benutzers zurück.

Unter POSIX wird die Umgebungsvariable $HOME verwendet, falls definiert. Andernfalls wird die effektive UID verwendet, um das Home-Verzeichnis des Benutzers zu finden.

Unter Windows wird die Umgebungsvariable USERPROFILE verwendet, falls definiert. Andernfalls wird der Pfad zum Profilverzeichnis des aktuellen Benutzers verwendet.

os.hostname()#

• Rückgabe: <string>

Gibt den Hostnamen des Betriebssystems als String zurück.

os.loadavg()#

• Rückgabe: <number[]>

Gibt ein Array zurück, das die durchschnittliche Systemauslastung der letzten 1, 5 und 15 Minuten enthält.

Die durchschnittliche Systemauslastung ist ein Maß für die Systemaktivität, das vom Betriebssystem berechnet und als Bruchzahl ausgedrückt wird.

Die durchschnittliche Systemauslastung ist ein Unix-spezifisches Konzept. Unter Windows ist der Rückgabewert immer [0, 0, 0].

os.machine()#

• Rückgabe: <string>

Gibt den Maschinentyp als String zurück, z. B. arm, arm64, aarch64, mips, mips64, ppc64, ppc64le, s390x, i386, i686, x86_64.

Unter POSIX-Systemen wird der Maschinentyp durch den Aufruf von uname(3) bestimmt. Unter Windows wird RtlGetVersion() verwendet, und wenn diese nicht verfügbar ist, wird GetVersionExW() verwendet. Weitere Informationen finden Sie unter https://en.wikipedia.org/wiki/Uname#Examples.

os.networkInterfaces()#

• Rückgabewert: <Object>

Gibt ein Objekt zurück, das Netzwerkschnittstellen enthält, denen eine Netzwerkadresse zugewiesen wurde.

Jeder Schlüssel im zurückgegebenen Objekt identifiziert eine Netzwerkschnittstelle. Der zugehörige Wert ist ein Array von Objekten, die jeweils eine zugewiesene Netzwerkadresse beschreiben.

Die in dem Objekt der zugewiesenen Netzwerkadresse verfügbaren Eigenschaften umfassen

• address <string> Die zugewiesene IPv4- oder IPv6-Adresse
• netmask <string> Die IPv4- oder IPv6-Netzmaske
• family <string> Entweder IPv4 oder IPv6
• mac <string> Die MAC-Adresse der Netzwerkschnittstelle
• internal <boolean> true, wenn die Netzwerkschnittstelle eine Loopback- oder ähnliche Schnittstelle ist, die nicht remote zugänglich ist; andernfalls false
• scopeid <number> Die numerische IPv6-Scope-ID (nur angegeben, wenn family IPv6 ist)
• cidr <string> Die zugewiesene IPv4- oder IPv6-Adresse mit dem Routing-Präfix in CIDR-Notation. Wenn die netmask ungültig ist, wird diese Eigenschaft auf null gesetzt.

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

• Rückgabe: <string>

Gibt einen String zurück, der die Betriebssystemplattform identifiziert, für die das Node.js-Binary kompiliert wurde. Der Wert wird zur Kompilierungszeit festgelegt. Mögliche Werte sind 'aix', 'darwin', 'freebsd','linux', 'openbsd', 'sunos' und 'win32'.

Der Rückgabewert entspricht process.platform.

Der Wert 'android' kann auch zurückgegeben werden, wenn Node.js auf dem Android-Betriebssystem erstellt wird. Die Android-Unterstützung ist experimentell.

os.release()#

• Rückgabe: <string>

Gibt das Betriebssystem als String zurück.

Unter POSIX-Systemen wird die Betriebssystemversion durch den Aufruf von uname(3) bestimmt. Unter Windows wird GetVersionExW() verwendet. Weitere Informationen finden Sie unter https://en.wikipedia.org/wiki/Uname#Examples.

os.setPriority([pid, ]priority)#

• pid <integer> Die Prozess-ID, für die die Planpriorität festgelegt werden soll. Standard: 0.
• priority <integer> Die dem Prozess zuzuweisende Planpriorität.

Versucht, die Planpriorität für den durch pid angegebenen Prozess festzulegen. Wenn pid nicht angegeben oder 0 ist, wird die Prozess-ID des aktuellen Prozesses verwendet.

Der priority-Input muss eine Ganzzahl zwischen -20 (hohe Priorität) und 19 (niedrige Priorität) sein. Aufgrund von Unterschieden zwischen Unix-Prioritätsstufen und Windows-Prioritätsklassen wird priority auf eine von sechs Prioritätskonstanten in os.constants.priority abgebildet. Beim Abrufen einer Prozessprioritätsstufe kann diese Bereichszuordnung dazu führen, dass der Rückgabewert unter Windows geringfügig abweicht. Um Verwechslungen zu vermeiden, setzen Sie priority auf eine der Prioritätskonstanten.

Unter Windows erfordert das Setzen der Priorität auf PRIORITY_HIGHEST erhöhte Benutzerrechte. Andernfalls wird die festgelegte Priorität stillschweigend auf PRIORITY_HIGH reduziert.

os.tmpdir()#

• Rückgabe: <string>

Gibt das Standardverzeichnis des Betriebssystems für temporäre Dateien als String zurück.

Unter Windows kann das Ergebnis durch die Umgebungsvariablen TEMP und TMP überschrieben werden, wobei TEMP Vorrang vor TMP hat. Wenn keines davon gesetzt ist, wird standardmäßig %SystemRoot%\temp oder %windir%\temp verwendet.

Auf Nicht-Windows-Plattformen werden die Umgebungsvariablen TMPDIR, TMP und TEMP in der beschriebenen Reihenfolge geprüft, um das Ergebnis dieser Methode zu überschreiben. Wenn keine davon gesetzt ist, wird standardmäßig /tmp verwendet.

Einige Betriebssystemdistributionen konfigurieren entweder TMPDIR (Nicht-Windows) oder TEMP und TMP (Windows) standardmäßig ohne zusätzliche Konfigurationen durch Systemadministratoren. Das Ergebnis von os.tmpdir() spiegelt in der Regel die Systempräferenz wider, es sei denn, es wird explizit von den Benutzern überschrieben.

os.totalmem()#

• Gibt zurück: <integer>

Gibt die Gesamtmenge des Systemspeichers in Bytes als Integer zurück.

os.type()#

• Rückgabe: <string>

Gibt den Betriebssystemnamen zurück, wie er von uname(3) geliefert wird. Zum Beispiel gibt es 'Linux' unter Linux, 'Darwin' unter macOS und 'Windows_NT' unter Windows zurück.

Weitere Informationen zur Ausgabe von uname(3) auf verschiedenen Betriebssystemen finden Sie unter https://en.wikipedia.org/wiki/Uname#Examples.

os.uptime()#

• Gibt zurück: <integer>

Gibt die System-Uptime in Sekunden zurück.

os.userInfo([options])#

• options <Object>
  • encoding <string> Zeichenkodierung, die zur Interpretation der resultierenden Strings verwendet wird. Wenn encoding auf 'buffer' gesetzt ist, sind die Werte für username, shell und homedir Buffer-Instanzen. Standard: 'utf8'.
• Rückgabewert: <Object>

Gibt Informationen über den aktuell effektiven Benutzer zurück. Auf POSIX-Plattformen ist dies typischerweise eine Untermenge der Passwortdatei. Das zurückgegebene Objekt enthält username, uid, gid, shell und homedir. Unter Windows sind die Felder uid und gid -1, und shell ist null.

Der von os.userInfo() zurückgegebene Wert von homedir wird vom Betriebssystem bereitgestellt. Dies unterscheidet sich vom Ergebnis von os.homedir(), das Umgebungsvariablen für das Home-Verzeichnis abfragt, bevor es auf die Antwort des Betriebssystems zurückgreift.

Wirft einen SystemError, wenn ein Benutzer keinen username oder homedir hat.

os.version()#

• Rückgabe: <string>

Gibt einen String zurück, der die Kernel-Version identifiziert.

Unter POSIX-Systemen wird die Betriebssystemversion durch den Aufruf von uname(3) bestimmt. Unter Windows wird RtlGetVersion() verwendet, und wenn diese nicht verfügbar ist, wird GetVersionExW() verwendet. Weitere Informationen finden Sie unter https://en.wikipedia.org/wiki/Uname#Examples.

OS-Konstanten#

Die folgenden Konstanten werden von os.constants exportiert.

Nicht alle Konstanten sind auf jedem Betriebssystem verfügbar.

Signalkonstanten#

Die folgenden Signalkonstanten werden von os.constants.signals exportiert.

Fehlerkonstanten#

Die folgenden Fehlerkonstanten werden von os.constants.errno exportiert.

POSIX-Fehlerkonstanten#

Windows-spezifische Fehlerkonstanten#

Die folgenden Fehlercodes sind spezifisch für das Windows-Betriebssystem.

dlopen-Konstanten#

Sofern auf dem Betriebssystem verfügbar, werden die folgenden Konstanten in os.constants.dlopen exportiert. Siehe dlopen(3) für detaillierte Informationen.

Prioritätskonstanten#

Die folgenden Prozessplanungs-Konstanten werden von os.constants.priority exportiert.

libuv-Konstanten#