Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "os"

Index

Modules

Interfaces

Type aliases

Variables

Functions

Type aliases

NetworkInterfaceInfo

NetworkInterfaceInfo: NetworkInterfaceInfoIPv4 | NetworkInterfaceInfoIPv6

SignalConstants

SignalConstants: object

Type declaration

Variables

Const EOL

EOL: string

Functions

arch

  • arch(): string

  • Returns string

cpus

  • Returns CpuInfo[]

endianness

  • endianness(): "BE" | "LE"

  • Returns "BE" | "LE"

freemem

  • freemem(): number

  • Returns number

getPriority

  • getPriority(pid?: number): number

  • Gets the priority of a process. Defaults to current process.

    Parameters

    • Optional pid: number

    Returns number

homedir

  • homedir(): string

  • Returns string

hostname

  • hostname(): string

  • Returns string

loadavg

  • loadavg(): number[]

  • Returns number[]

networkInterfaces

platform

  • Returns Platform

release

  • release(): string

  • Returns string

setPriority

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

  • Sets the priority of the current process.

    Parameters

    • priority: number

      Must be in range of -20 to 19

    Returns void

  • Sets the priority of the process specified process.

    Parameters

    • pid: number
    • priority: number

      Must be in range of -20 to 19

    Returns void

tmpdir

  • tmpdir(): string

  • Returns string

totalmem

  • totalmem(): number

  • Returns number

type

  • type(): string

  • Returns string

uptime

  • uptime(): number

  • Returns number

userInfo

  • Parameters

    • options: object
      • encoding: "buffer"

    Returns UserInfo<Buffer>

  • Parameters

    Returns UserInfo<string>

version

  • version(): string

  • Returns a string identifying the kernel version. On POSIX systems, the operating system release is determined by calling [uname(3)][]. On Windows, pRtlGetVersion is used, and if it is not available, GetVersionExW() will be used. See https://en.wikipedia.org/wiki/Uname#Examples for more information.

    Returns string

Generated using TypeDoc