https://github.com/mojoaxel/freem
Get free RAM (Main Memory) space info from free command
https://github.com/mojoaxel/freem
Last synced: 3 months ago
JSON representation
Get free RAM (Main Memory) space info from free command
- Host: GitHub
- URL: https://github.com/mojoaxel/freem
- Owner: mojoaxel
- Created: 2016-02-15T23:08:04.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-15T23:26:48.000Z (over 9 years ago)
- Last Synced: 2024-10-18T23:31:15.033Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.95 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# freem
> Get free RAM (Main Memory) space info from `free` command
Works on Linux.
*Inspired by [`sindresorhus/df`](https://github.com/sindresorhus/df)*
## Install
```
$ npm install --save freem
```
## Usage
```js
var free = require('freem');
free(function (err, list) {
console.log(list);
/*
[
{
type: 'Mem:',
total: '8095596',
used: '7056436',
free: '1039160',
shared: '625412',
buffers: '261384',
cached: '2203688'
},
{
type: '-/+ buffers/cache:',
used: '4591364',
free: '3504232'
},
{
type: 'Swap:',
total: '8307708',
used: '200',
free: '8307508'
}
]
*/
});
free.k(function (err, data) {
console.log(data);
/*
[
{
type: 'Mem:',
...
},
{
type: '-/+ buffers/cache:',
...
},
{
type: 'Swap:',
...
}
]
*/
});
free.m(function (err, data) {
console.log(data);
/*
[
{
type: 'Mem:',
...
},
{
type: '-/+ buffers/cache:',
...
},
{
type: 'Swap:',
...
}
]
*/
});
free.g(function (err, data) {
console.log(data);
/*
[
{
type: 'Mem:',
...
},
{
type: '-/+ buffers/cache:',
...
},
{
type: 'Swap:',
...
}
]
*/
});
```
## API
### free(callback)
Get a list of main memory info.
#### callback(error, list)
*Required*
Type: `function`
##### list
Type: `array`
List of `data` objects.
## License
MIT © [Jayram Singh](http://github.com/jaysingh)