OS

API support and documentation for the node:os module.

import os from "node:os"

const os = require("node:os")

Modules

Status	Module	Docs
🟢 Supported.	`node:os`	Node.js OS

`os` | Properties

EOL: 🟢 Supported.
devNull: 🟢 Supported.

`os` | Methods

availableParallelism(): 🟢 Supported.
arch(): 🟢 Supported.
cpus(): 🟢 Supported.
endianness(): 🟢 Supported.
freemem(): 🟢 Supported.
getPriority([pid]): 🔴 Not implemented.
homedir(): 🟢 Supported.
hostname(): 🟢 Supported.
loadavg(): 🟢 Supported.
machine(): 🔴 Not implemented.
networkInterfaces(): 🟡 Implemented; not yet compliant.
platform(): 🟢 Supported.
release(): 🟡 Implemented; not yet compliant.
setPriority([pid, ]priority): 🔴 Not implemented.
tmpdir(): 🟢 Supported.
totalmem(): 🟢 Supported.
type(): 🟢 Supported.
uptime(): 🟢 Supported.
userInfo([options]): 🔴 Not implemented.
version(): 🟡 Implemented; not yet compliant.

--

appendFile(path, data[, options], callback): 🔴 Not implemented.
readFile(path[, options], callback): 🟡 Supported for UTF-8 reads. Binary reads do not work yet.

Last modified: 14 May 2024