bare-os

stable

bare-os exposes operating-system information and process utilities for Bare, closely mirroring the Node.js os module so most Node code ports directly.

Mirrors the Node.js os module.

npm i bare-os

Usage

const os = require('bare-os')

console.log(os.platform()) // 'darwin', 'linux', 'win32', ...
console.log(os.arch()) // 'arm64', 'x64', ...
console.log(os.homedir())
console.log(os.tmpdir())
console.log(os.hostname())
console.log(os.networkInterfaces())

API

System and platform

`platform(): 'android' | 'darwin' | 'ios' | 'linux' | 'win32'`

_Source

Returns the operating system platform as a string. Possible values include 'android', 'darwin', 'ios', 'linux', and 'win32'.

`arch(): 'arm' | 'arm64' | 'ia32' | 'x64'`

_Source

Returns the CPU architecture as a string. Possible values include 'arm', 'arm64', 'ia32', and 'x64'.

`type(): string`

_Source

Returns the operating system name as returned by uname(3).

`version(): string`

_Source

Returns the operating system version.

`release(): string`

_Source

Returns the operating system release.

`machine(): string`

_Source

Returns the machine type as a string.

`endianness(): 'LE' | 'BE'`

_Source

Returns 'LE' on little-endian systems and 'BE' on big-endian systems.

`availableParallelism(): number`

_Source

Returns the number of logical CPU cores available to the process.

Process and scheduling

`pid(): number`

_Source

Returns the process ID.

`ppid(): number`

_Source

Returns the parent process ID.

`cwd(): string`

_Source

Returns the current working directory.

`chdir(dir: string): void`

_Source

Changes the current working directory to dir.

Parameters

Parameter	Type	Default	Description
`dir`	`string`	—	Path of the directory to make the new working directory.

Throws

Thrown with the underlying system error code (for example ENOENT) when dir does not exist or cannot be entered.

`execPath(): string`

_Source

Returns the absolute path of the executable that started the process.

`kill(pid: number, signal?: string | number): void`

_Source

Sends signal to the process identified by pid. signal can be a string or a number. Defaults to 'SIGTERM'.

Parameters

Parameter	Type	Default	Description
`pid`	`number`	—	Process id to signal.
`signal?`	`string` \| `number`	—	Signal name or number to send (default `'SIGTERM'`); `0` probes for the process's existence without sending a signal.

Throws

UNKNOWN_SIGNAL — Thrown as an OSError when signal is a string that is not a recognized signal name.
Thrown with the underlying system error code (for example ESRCH) when pid does not identify a running process.

`getProcessTitle(): string`

_Source

Returns the current process title.

`setProcessTitle(title: unknown): void`

_Source

Sets the process title. title is coerced to a string and must be shorter than 256 characters.

Parameters

Parameter	Type	Default	Description
`title`	`unknown`	—	New process title; coerced to a string if not already one.

Throws

TITLE_OVERFLOW — Thrown as an OSError when the process title is 256 characters or longer.

`getPriority(pid?: number): number`

_Source

Returns the scheduling priority of the process specified by pid. Defaults to 0, meaning the current process.

Parameters

Parameter	Type	Default	Description
`pid?`	`number`	—	Process id to query; defaults to `0` (the current process).

`setPriority(priority: number): void`

_Source

Sets the scheduling priority of the process specified by pid. If pid is omitted, the priority of the current process is set.

Overloads:

setPriority(priority: number): void
setPriority(pid: number, priority: number): void

Parameters

Parameter	Type	Default	Description
`priority`	`number`	—	Nice value to set.

Users and network

`userInfo(uid?: number): UserInfo`

_Source

Returns information about a current user. The uid value defaults to the current effective uid.

Parameters

Parameter	Type	Default	Description
`uid?`	`number`	—	User ID to look up; defaults to the current effective uid.

`groupInfo(gid?: number): GroupInfo | null`

_Source

Returns information about a group. The gid value defaults to the effective group ID of the calling process.

Parameters

Parameter	Type	Default	Description
`gid?`	`number`	—	Group ID to look up; defaults to the effective group ID of the calling process.

Returns GroupInfo | null — null on platforms that do not support group lookups (for example, Windows).

`hostname(): string`

_Source

Returns the hostname of the operating system.

`networkInterfaces(): Record<string, NetworkInterface[]>`

_Source

Returns an object containing network interfaces that have been assigned a network address. Each key on the returned object identifies a network interface.

Memory and CPU

`cpus`

cpus(): {
  model: string
  speed: number
  times: {
    user: number
    nice: number
    sys: number
    idle: number
    irq: number
  }
}[]

_Source

Returns an array of objects describing each logical CPU core.

`cpuUsage(previous?: CpuUsage): CpuUsage`

_Source

Returns an object with user and system properties, each representing CPU time in microseconds. If previous is provided, the returned values are relative to it.

Parameters

Parameter	Type	Default	Description
`previous?`	`CpuUsage`	—	A previous `CpuUsage` snapshot to compute a relative diff against.

`threadCpuUsage(previous?: CpuUsage): CpuUsage`

_Source

Like os.cpuUsage() but for the current thread only.

Parameters

Parameter	Type	Default	Description
`previous?`	`CpuUsage`	—	A previous `CpuUsage` snapshot (from `threadCpuUsage()`) to compute a relative diff against.

`resourceUsage`

resourceUsage(): {
  userCPUTime: number
  systemCPUTime: number
  maxRSS: number
  sharedMemorySize: number
  unsharedDataSize: number
  unsharedStackSize: number
  minorPageFault: number
  majorPageFault: number
  swappedOut: number
  fsRead: number
  fsWrite: number
  ipcSent: number
  ipcReceived: number
  signalsCount: number
  voluntaryContextSwitches: number
  involuntaryContextSwitches: number
}

_Source

Returns an object describing the resource usage of the current process.

`memoryUsage`

memoryUsage(): {
  rss: number
  heapTotal: number
  heapUsed: number
  external: number
}

_Source

Returns an object describing the memory usage of the process.

Parameters

Parameter	Type	Default	Description
`name`	`string`	—	Name of the environment variable to read.

`hasEnv(name: string): boolean`

_Source

Returns true if the environment variable name is set, otherwise false.

Parameters

Parameter	Type	Default	Description
`name`	`string`	—	Name of the environment variable to check.

`setEnv(name: string, value: string): void`

_Source

Sets the environment variable name to value.

Parameters

Parameter	Type	Default	Description
`name`	`string`	—	Name of the environment variable to set.
`value`	`string`	—	Value to assign to the environment variable.

`unsetEnv(name: string): void`

_Source

Removes the environment variable name.

Parameters

Parameter	Type	Default	Description
`name`	`string`	—	Name of the environment variable to remove.

constants: {
  signals: Record<string, number>
  errnos: Record<string, number>
  priority: Record<string, number>
}

_Source

An object of signal, error-number, and process-priority constants.

`errors`

_Source

class errors {
  code: string
}

Types

`NetworkInterface`

interface NetworkInterface {
  address: string
  netmask: string
  family: 'IPv4' | 'IPv6'
  cidr: string
  mac: string
  internal: boolean
  scopeid?: number
}

_Source

`UserInfo`

interface UserInfo {
  uid: number
  gid: number
  username: string
  homedir: string
  shell: string | null
}

_Source

`GroupInfo`

interface GroupInfo {
  groupname: string
  gid: number
  members: string[]
}

_Source

`CpuUsage`

interface CpuUsage {
  user: number
  system: number
}

_Source

constants: {
  signals: Record<string, number>
  errnos: Record<string, number>
  priority: Record<string, number>
}

_Source

An object of signal, error-number, and process-priority constants.

class OSError {
  code: string
}

bare-os

On this page