address

Get current machine IPv4, IPv6, MAC and DNS servers.

DNS servers receive from /etc/resolv.conf.

Install

1npm install address

Usage

Get IP is sync and get MAC is async for now.

• esm & typescript

1import { ip, ipv6, mac } from 'address';
2
3// default interface 'eth' on linux, 'en' on osx.
4ip();   // '192.168.0.2'
5ipv6(); // 'fe80::7aca:39ff:feb0:e67d'
6mac(function (err, addr) {
7  console.log(addr); // '78:ca:39:b0:e6:7d'
8});
9
10// local loopback
11ip('lo'); // '127.0.0.1'
12
13// vboxnet MAC
14mac('vboxnet', function (err, addr) {
15  console.log(addr); // '0a:00:27:00:00:00'
16});

• commonjs

1const { ip, ipv6, mac } = require('address');
2
3// default interface 'eth' on linux, 'en' on osx.
4ip();   // '192.168.0.2'
5ipv6(); // 'fe80::7aca:39ff:feb0:e67d'
6mac(function (err, addr) {
7  console.log(addr); // '78:ca:39:b0:e6:7d'
8});
9
10// local loopback
11ip('lo'); // '127.0.0.1'
12
13// vboxnet MAC
14mac('vboxnet', function (err, addr) {
15  console.log(addr); // '0a:00:27:00:00:00'
16});

Get all addresses: IPv4, IPv6 and MAC

• esm & typescript

1import { address } from 'address';
2
3address((err, addrs) => {
4  console.log(addrs.ip, addrs.ipv6, addrs.mac);
5  // '192.168.0.2', 'fe80::7aca:39ff:feb0:e67d', '78:ca:39:b0:e6:7d'
6});
7
8address('vboxnet', (err, addrs) => {
9  console.log(addrs.ip, addrs.ipv6, addrs.mac);
10  // '192.168.56.1', null, '0a:00:27:00:00:00'
11});

• commonjs

1const { address } = require('address');
2
3address((err, addrs) => {
4  console.log(addrs.ip, addrs.ipv6, addrs.mac);
5  // '192.168.0.2', 'fe80::7aca:39ff:feb0:e67d', '78:ca:39:b0:e6:7d'
6});
7
8address('vboxnet', (err, addrs) => {
9  console.log(addrs.ip, addrs.ipv6, addrs.mac);
10  // '192.168.56.1', null, '0a:00:27:00:00:00'
11});

Get an interface info with family

• esm & typescript

1import { getInterfaceAddress } from 'address';
2
3getInterfaceAddress('IPv4', 'eth1');
4// { address: '192.168.1.1', family: 'IPv4', mac: '78:ca:39:b0:e6:7d' }

• commonjs

1const { getInterfaceAddress } = require('address');
2
3getInterfaceAddress('IPv4', 'eth1');
4// { address: '192.168.1.1', family: 'IPv4', mac: '78:ca:39:b0:e6:7d' }

Get DNS servers

• esm & typescript

1import { dns } from 'address';
2
3dns((err, servers) => {
4  console.log(servers);
5  // ['10.13.2.1', '10.13.2.6']
6});

• commonjs

1const { dns } = require('address');
2
3dns((err, servers) => {
4  console.log(servers);
5  // ['10.13.2.1', '10.13.2.6']
6});

Promise style apis

1import { address, mac, dns } from 'address/promises';
2
3const addr = await address();
4const macAddress = await mac();
5const servers = await dns();

License

MIT

Contributors

fengmk2	alsotang	jkelleyrtp	slyon	mariodu	mathieutu
zhangyuheng	semantic-release-bot	coolme200	whxaxes

This project follows the git-contributor spec, auto updated at Fri Sep 22 2023 20:49:32 GMT+0800.