The 'address' npm package is a utility for retrieving detailed information about the network interfaces of the host machine. It can be used to get IP addresses, MAC addresses, and DNS servers, among other things. This package is particularly useful for applications that need to be aware of the network configuration of the host they are running on.
Get IP Address
This feature allows you to retrieve the IPv4 or IPv6 address of the host machine. It's useful for applications that need to know their own IP address, for instance, to communicate with other services in a network.
const address = require('address');
// Get the IPv4 address
address.ip(); // '192.168.0.2'
// Get the IPv6 address
address.ipv6(); // 'fe80::7ca0:ab22:703a:b329'Get MAC Address
This feature enables you to get the MAC address of the host machine. This can be useful for applications that need to identify the network interface of the host.
const address = require('address');
// Get the MAC address
address.mac(function (err, addr) {
console.log(addr); // '78:ca:39:b0:e6:7c'
});Get DNS Servers
This feature provides the DNS servers configured on the host machine. It's useful for applications that need to perform DNS lookups or need to know about the network's DNS configuration.
const address = require('address');
// Get DNS servers
console.log(address.dns()); // ['8.8.8.8', '8.8.4.4']The 'ip' package is similar to 'address' in that it provides utilities for IP address manipulation and querying. However, it focuses more on the manipulation and calculation of IP addresses rather than retrieving network interface details.
The 'network' package offers functionality to get network information such as the user's IP, MAC address, and network interfaces, similar to 'address'. However, it also includes additional features like checking internet connectivity, which 'address' does not provide.
While not a third-party package, Node.js's built-in 'os' module provides some overlapping functionality with 'address', such as retrieving network interfaces. However, 'address' offers more detailed and specific network information retrieval capabilities.
Get current machine IPv4, IPv6, MAC and DNS servers.
DNS servers receive from /etc/resolv.conf.
npm install address
Get IP is sync and get MAC is async for now.
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'
});
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'
});
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'
});
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'
});
import { getInterfaceAddress } from 'address';
getInterfaceAddress('IPv4', 'eth1');
// { address: '192.168.1.1', family: 'IPv4', mac: '78:ca:39:b0:e6:7d' }
const { getInterfaceAddress } = require('address');
getInterfaceAddress('IPv4', 'eth1');
// { address: '192.168.1.1', family: 'IPv4', mac: '78:ca:39:b0:e6:7d' }
import { dns } from 'address';
dns((err, servers) => {
console.log(servers);
// ['10.13.2.1', '10.13.2.6']
});
const { dns } = require('address');
dns((err, servers) => {
console.log(servers);
// ['10.13.2.1', '10.13.2.6']
});
import { address, mac, dns } from 'address/promises';
const addr = await address();
const macAddress = await mac();
const servers = await dns();
 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.
2.0.3 (2024-06-19)
FAQs
Get current machine IP, MAC and DNS servers.
The npm package address receives a total of 7,707,799 weekly downloads. As such, address popularity was classified as popular.
We found that address demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
TypeScript is porting its compiler to Go, delivering 10x faster builds, lower memory usage, and improved editor performance for a smoother developer experience.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.