Have ideas to improve npm?Join in the discussion! »

    getmac
    TypeScript icon, indicating that this package has built-in type declarations

    5.17.0 • Public • Published

    getmac

    Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

    Get the MAC address of the current machine you are on.

    This library will not run in web browsers / on the client-side / in webpack / in browserify / in angular / in react / in jQuery / in HTML. It will only run on Node.js environments, which the web browser is not.

    Usage

    Complete API Documentation.

    CLI

    Install globally npm install -g getmac, then run with getmac-node

    API

    Install locally npm install --save getmac, then use like so:

    import getMAC, { isMAC } from 'getmac'
     
    // Fetch the computer's MAC address
    console.log(getMAC())
     
    // Fetch the computer's MAC address for a specific interface
    console.log(getMAC('eth0'))
     
    // Validate that an address is a MAC address
    if (isMAC('e4:ce:8f:5b:a7:fc')) {
        console.log('valid MAC')
    } else {
        console.log('invalid MAC')
    }

    Advanced

    If you want to do advanced filtering, use os.networkInterfaces() instead.

    Install

    npm

    • Install: npm install --save getmac
    • Import: import pkg from ('getmac')
    • Require: const pkg = require('getmac').default

    Deno

    import pkg from 'https://unpkg.com/getmac@^5.17.0/edition-deno/index.ts'

    Editions

    This package is published with the following editions:

    • getmac/source/index.ts is TypeScript source code with Import for modules
    • getmac aliases getmac/edition-esnext/index.js
    • getmac/edition-esnext/index.js is TypeScript compiled against ESNext for Node.js 10 || 12 || 14 || 15 with Require for modules
    • getmac/edition-esnext-esm/index.js is TypeScript compiled against ESNext for Node.js 12 || 14 || 15 with Import for modules
    • getmac/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

    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?

    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

    Contributors

    These amazing people have contributed code to this project:

    Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

    License

    Unless stated otherwise all works are:

    and licensed under:

    Install

    npm i getmac

    DownloadsWeekly Downloads

    12,687

    Version

    5.17.0

    License

    MIT

    Unpacked Size

    38.3 kB

    Total Files

    20

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar