Package Exports
- getmac
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (getmac) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
getmac
Get the mac address of the current machine you are on
Will run anywhere that the underlying commands are present:
Install
- Install:
npm install --save getmac
- Executable:
getmac-node
- Module:
require('getmac')
Editions
This package is published with the following editions:
getmac/src/lib/getmac.coffee
is Source + CoffeeScript + Requiregetmac
aliasesgetmac/es5/lib/getmac.js
getmac/es5/lib/getmac.js
is CoffeeScript Compiled JavaScript + ES5 + Require
Usage
CLI
- Install Globally:
install -g getmac
- Run with:
getmac-node
API
// Fetch the computer's mac address
require('getmac').getMac(function(err, macAddress){
if (err) throw err
console.log(macAddress)
})
// Fetch the computer's mac address for a specfici interace
require('getmac').getMac({iface: 'eth0'}, function(err, macAddress){
if (err) throw err
console.log(macAddress)
})
// Validate that an address is a mac address
if ( require('getmac').isMac("e4:ce:8f:5b:a7:fc") ) {
console.log('valid mac')
}
else {
console.log('invalid mac')
}
History
Discover the release history by heading on over to the HISTORY.md
file.
Contribute
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
Backers
Maintainers
These amazing people are maintaining this project:
Sponsors
No sponsors yet! Will you be the first?
Contributors
These amazing people have contributed code to this project:
- Benjamin Lupton — view contributions
- Stephen Brown II — view contributions
- ted shroyer — view contributions
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
License
Unless stated otherwise all works are:
- Copyright © 2013+ Bevry Pty Ltd
and licensed under: