# get-loadavg

> returns the load average for the Unix-like systems but in an object

Latest version **1.0.0** (published 2016-11-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install get-loadavg
pnpm add get-loadavg
yarn add get-loadavg
bun add get-loadavg
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-11-05 |
| First published | 2016-11-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.1 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | @JoaquimSerafim |
| Maintainers | quim |
| Keywords | loadavg, unix, linux, system, utils, cpu, performance |

## Links

- npm: https://www.npmjs.com/package/get-loadavg
- Repository: https://github.com/joaquimserafim/get-loadavg
- Issues: https://github.com/joaquimserafim/get-loadavg/issues
- npm.io page: https://npm.io/package/get-loadavg

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2016-11-05

## README

# get-loadavg

returns the load average for the Unix-like systems but in an object

----
<a href="https://nodei.co/npm/get-loadavg/"><img src="https://nodei.co/npm/get-loadavg.png?downloads=true"></a>

[![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg?style=flat-square)](https://travis-ci.org/joaquimserafim/get-loadavg)![Code Coverage 100%](https://img.shields.io/badge/code%20coverage-100%25-green.svg?style=flat-square)[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg?style=flat-square)](https://github.com/joaquimserafim/get-loadavg/blob/master/LICENSE)[![NodeJS](https://img.shields.io/badge/node-6.1.x-brightgreen.svg?style=flat-square)](https://github.com/joaquimserafim/get-loadavg/blob/master/package.json#L33)

[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)


### api
**returns an object with the following properties:**

* **idle** % of CPU idle of the time - this property should be returned when the load is below the number of CPUs
* **overload** % of CPU overloaded on average - this property should be returned when the load is above the number of CPUs
* **processes** % of processes were waiting for the CPU - this property should be returned when the load is above the number of CPUs

### example


```js
const getLoadAvg = require('get-loadavg')

// let's suppose that the current loadavg is [9.19921875, 5.2197265625, 3.16796875] and we have 4 CPUs
getLoadAvg()
// should return
{
  one: {
    overload: 519.92,
    processes: 5.2
  },
  five: {
    overload: 121.97,
    processes: 1.22
  },
  fifteen: {
    idle: 20.8
  }
}
```



#### ISC License (ISC)

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