{ } qjs-modules

node:os

Source: lib/node/os.js — import as node:os (also require('os'), require('node:os')); qjsm only. The bare os stays QuickJS's own os module.

Node's os: facts about the machine, the user and the kernel. On Linux they come from misc.uname(), /proc, /sys and /etc/passwd, read on every call.

import os from 'node:os';

os.cpus().length;          // 8
os.totalmem();             // 33571848192
os.userInfo().username;    // 'roman'
`${os.hostname}`;          // 'gniltag', the getters convert as in Node
MemberResultFrom
arch(), platform()'x64', 'linux'process.arch, process.platform
type(), release(), version(), machine(), hostname()uname(2) fieldsmisc.uname()
endianness()'LE' or 'BE'
homedir()$HOME, else the user's home directory/etc/passwd
tmpdir()$TMPDIR, $TMP, $TEMP or /tmp, no trailing /
userInfo({ encoding }){ uid, gid, username, homedir, shell }, Buffers with 'buffer'/etc/passwd
cpus(){ model, speed, times: { user, nice, sys, idle, irq } } per CPU, times in ms/proc/cpuinfo, /proc/stat, /sys/.../scaling_cur_freq
availableParallelism()CPUs in the affinity mask/proc/self/status
freemem(), totalmem()bytes, MemAvailable and MemTotal/proc/meminfo
loadavg(), uptime()[1, 5, 15] minute averages, seconds/proc/loadavg, /proc/uptime
getPriority(pid = 0)nice value/proc/<pid>/stat
setPriority([pid,] priority)throws InternalError after checking the arguments
networkInterfaces()throws InternalError
constantssignals, errno, priority, dlopen, UV_UDP_REUSEADDRmisc
EOL, devNull'\n', '/dev/null'

Errors have Node's codes: TypeError ERR_INVALID_ARG_TYPE and RangeError ERR_OUT_OF_RANGE for a bad pid or priority, SystemError ERR_SYSTEM_ERROR (ESRCH for a missing process, ENOENT for a user without a passwd entry).

Missing compared with Node

NodeHere
networkInterfaces()InternalError: needs a getifaddrs(3) binding
setPriority()InternalError: needs a setpriority(2) binding
userInfo() for NSS users (LDAP, sssd)SystemError ENOENT: only /etc/passwd is read
macOS, Windows, BSDthe /proc functions throw InternalError

Export list

Generated by utilities/doc-api.js from the node_os dump of utilities/api-surface.sh: 52 members. Edit the text above this block, not the block.

Functions: arch(), availableParallelism(), cpus(), endianness(), freemem(), getPriority(), homedir(), hostname(), loadavg(), machine(), networkInterfaces(), platform(), release(), setPriority(), tmpdir(), totalmem(), type(), uptime(), userInfo(), version()

Values: EOL, devNull

constants

object

  • static values: UV_UDP_REUSEADDR = 4, dlopen, errno, priority, signals

default

object

  • static methods: arch(), availableParallelism(), cpus(), endianness(), freemem(), getPriority(), homedir(), hostname(), loadavg(), machine(), networkInterfaces(), platform(), release(), setPriority(), tmpdir(), totalmem(), type(), uptime(), userInfo(), version()
  • static values: EOL, constants, devNull