# @types/os-utils

> TypeScript definitions for os-utils

Latest version **0.0.4** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/os-utils
pnpm add @types/os-utils
yarn add @types/os-utils
bun add @types/os-utils
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2023-11-07 |
| First published | 2019-10-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51420 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/os-utils
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/os-utils
- npm.io page: https://npm.io/package/@types/os-utils

## Recent versions

- 0.0.4 (latest) — 2023-11-07
- 0.0.2 (ts4.3) — 2023-09-03
- 0.0.1 (ts3.0) — 2020-08-14
- 0.0.0 (ts2.0) — 2019-10-24
- 0.0.3 — 2023-10-18

## README

# Installation
> `npm install --save @types/os-utils`

# Summary
This package contains type definitions for os-utils (https://github.com/oscmejia/os-utils).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/os-utils.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/os-utils/index.d.ts)
````ts
type Platform =
    | "aix"
    | "android"
    | "darwin"
    | "freebsd"
    | "linux"
    | "openbsd"
    | "sunos"
    | "win32"
    | "cygwin";

/**
 * returns platform.
 * @return Platform
 */
export function platform(): Platform;

/**
 * returns number of cpus.
 * @return number
 */
export function cpuCount(): number;

/**
 * returns system up time in seconds.
 * @return number
 */
export function sysUptime(): number;

/**
 * returns process up time in seconds.
 * @return number
 */
export function processUptime(): number;

/**
 * returns free memory in megabytes.
 * @return number
 */
export function freemem(): number;

/**
 * returns total memory in megabytes.
 * @return number
 */
export function totalmem(): number;

/**
 * returns the percentage of free memory.
 * @return number
 */
export function freememPercentage(): number;

/**
 * execute free command (only linux).
 */
export function freeCommand(callback: (used_mem: number) => any): void;

/**
 * execute df -k command.
 */
export function harddrive(callback: (total: number, free: number, used: number) => any): void;

/**
 * return process running current.
 */
export function getProcesses(callback: (result: string) => any): void;

/**
 * return process running current.
 */
export function getProcesses(nProcess: number, callback: (result: string) => any): void;

/**
 * returns all the load average usage for 1, 5 or 15 minutes.
 * @return string
 */
export function allLoadavg(): string;

/**
 * returns the load average usage for 1, 5 or 15 minutes.
 * @return number
 */
export function loadavg(_time?: number): number;

/**
 * returns the free percentage of cpu usage.
 */
export function cpuFree(callback: (percentage: number) => any): void;

/**
 * returns the percentage of cpu usage.
 */
export function cpuUsage(callback: (percentage: number) => any): void;

export {};

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [Nasreddine Bac Ali](https://github.com/bacali95).

---
_Source: https://npm.io/package/@types/os-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._