# address > Get current machine IP, MAC and DNS servers. Latest version **2.0.3** (published 2024-06-19) · MIT license · 0 weekly downloads ## Install ```sh npm install address pnpm add address yarn add address bun add address ``` ## Health **Score 45/100 (D)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; has provenance; high quality score. Warnings: low downloads. Negative: abandoned. ## Facts | | | |---|---| | Version | 2.0.3 | | Published | 2024-06-19 | | First published | 2013-07-31 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >= 16.0.0 | | Dependencies | 0 | | Unpacked size | 61.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 237 | | Author | fengmk2 | | Maintainers | fengmk2 | | Keywords | address, ip, ipv4, mac | ## Links - npm: https://www.npmjs.com/package/address - Repository: https://github.com/node-modules/address - Homepage: https://github.com/node-modules/address#readme - Issues: https://github.com/node-modules/address/issues - npm.io page: https://npm.io/package/address ## Alternatives - [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads - [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads - [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads - [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads - [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads ## Recent versions - 2.0.3 (latest) — 2024-06-19 - 1.2.2 (release-1.x) — 2022-12-17 - 2.0.2 — 2024-02-29 - 2.0.1 — 2023-09-22 - 2.0.0 — 2023-09-22 - 1.2.1 — 2022-09-13 - 1.2.0 — 2022-04-29 - 1.1.2 — 2019-08-26 - 1.1.1 — 2019-08-22 - 1.1.0 — 2019-04-24 - 1.0.3 — 2017-08-24 - 1.0.2 — 2017-05-25 - 1.0.1 — 2016-09-30 - 1.0.0 — 2015-08-05 - 0.0.3 — 2013-11-04 - … 2 more at https://npm.io/package/address/versions ## README # address [![NPM version][npm-image]][npm-url] [![Node.js CI](https://github.com/node-modules/address/actions/workflows/nodejs.yml/badge.svg)](https://github.com/node-modules/address/actions/workflows/nodejs.yml) [![Test coverage][coveralls-image]][coveralls-url] [![npm download][download-image]][download-url] [npm-image]: https://img.shields.io/npm/v/address.svg?style=flat-square [npm-url]: https://npmjs.org/package/address [coveralls-image]: https://img.shields.io/coveralls/node-modules/address.svg?style=flat-square [coveralls-url]: https://coveralls.io/r/node-modules/address?branch=master [download-image]: https://img.shields.io/npm/dm/address.svg?style=flat-square [download-url]: https://npmjs.org/package/address Get current machine IPv4, IPv6, MAC and DNS servers. DNS servers receive from `/etc/resolv.conf`. ## Install ```bash npm install address ``` ## Usage Get IP is sync and get MAC is async for now. - esm & typescript ```ts import { ip, ipv6, mac } from 'address'; // default interface 'eth' on linux, 'en' on osx. ip(); // '192.168.0.2' ipv6(); // 'fe80::7aca:39ff:feb0:e67d' mac(function (err, addr) { console.log(addr); // '78:ca:39:b0:e6:7d' }); // local loopback ip('lo'); // '127.0.0.1' // vboxnet MAC mac('vboxnet', function (err, addr) { console.log(addr); // '0a:00:27:00:00:00' }); ``` - commonjs ```js const { ip, ipv6, mac } = require('address'); // default interface 'eth' on linux, 'en' on osx. ip(); // '192.168.0.2' ipv6(); // 'fe80::7aca:39ff:feb0:e67d' mac(function (err, addr) { console.log(addr); // '78:ca:39:b0:e6:7d' }); // local loopback ip('lo'); // '127.0.0.1' // vboxnet MAC mac('vboxnet', function (err, addr) { console.log(addr); // '0a:00:27:00:00:00' }); ``` ### Get all addresses: IPv4, IPv6 and MAC - esm & typescript ```ts import { address } from 'address'; address((err, addrs) => { console.log(addrs.ip, addrs.ipv6, addrs.mac); // '192.168.0.2', 'fe80::7aca:39ff:feb0:e67d', '78:ca:39:b0:e6:7d' }); address('vboxnet', (err, addrs) => { console.log(addrs.ip, addrs.ipv6, addrs.mac); // '192.168.56.1', null, '0a:00:27:00:00:00' }); ``` - commonjs ```js const { address } = require('address'); address((err, addrs) => { console.log(addrs.ip, addrs.ipv6, addrs.mac); // '192.168.0.2', 'fe80::7aca:39ff:feb0:e67d', '78:ca:39:b0:e6:7d' }); address('vboxnet', (err, addrs) => { console.log(addrs.ip, addrs.ipv6, addrs.mac); // '192.168.56.1', null, '0a:00:27:00:00:00' }); ``` ### Get an interface info with family - esm & typescript ```ts import { getInterfaceAddress } from 'address'; getInterfaceAddress('IPv4', 'eth1'); // { address: '192.168.1.1', family: 'IPv4', mac: '78:ca:39:b0:e6:7d' } ``` - commonjs ```js const { getInterfaceAddress } = require('address'); getInterfaceAddress('IPv4', 'eth1'); // { address: '192.168.1.1', family: 'IPv4', mac: '78:ca:39:b0:e6:7d' } ``` ### Get DNS servers - esm & typescript ```js import { dns } from 'address'; dns((err, servers) => { console.log(servers); // ['10.13.2.1', '10.13.2.6'] }); ``` - commonjs ```js const { dns } = require('address'); dns((err, servers) => { console.log(servers); // ['10.13.2.1', '10.13.2.6'] }); ``` ### Promise style apis ```ts import { address, mac, dns } from 'address/promises'; const addr = await address(); const macAddress = await mac(); const servers = await dns(); ``` ## License [MIT](LICENSE.txt) ## Contributors |[
fengmk2](https://github.com/fengmk2)
|[
alsotang](https://github.com/alsotang)
|[
jkelleyrtp](https://github.com/jkelleyrtp)
|[
slyon](https://github.com/slyon)
|[
mariodu](https://github.com/mariodu)
|[
mathieutu](https://github.com/mathieutu)
| | :---: | :---: | :---: | :---: | :---: | :---: | [
zhangyuheng](https://github.com/zhangyuheng)
|[
semantic-release-bot](https://github.com/semantic-release-bot)
|[
coolme200](https://github.com/coolme200)
|[
whxaxes](https://github.com/whxaxes)
This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Fri Sep 22 2023 20:49:32 GMT+0800`. --- _Source: https://npm.io/package/address · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._