default-gateway

default-gateway

Get the default network gateway, cross-platform.

Obtains the machine's default gateway through exec calls to OS routing interfaces. Supports Linux, macOS and Windows and Android. On Linux and Android, the ip command must be available (usually provided by the iproute2 package).

Installation

$ npm install default-gateway

Example

const defaultGateway = require('default-gateway');

defaultGateway.v4().then(result => {
  //=> {gateway: '1.2.3.4', interface: 'en1'}
});

defaultGateway.v6().then(result => {
  //=> {gateway: '2001:db8::1', interface: 'en2'}
});

API

defaultGateway.v4()

Returns a promise that resolves to a object containing the IPv4 gateway and interface properties. If it succeeds, gateway will always be defined, while interface can be null if it cannot be determined. Rejects when the gateway cannot be determined.

defaultGateway.v6()

Returns a promise that resolves to a object containing the IPv6 gateway and interface properties. If it succeeds, gateway will always be defined, while interface can be null if it cannot be determined. Rejects when the gateway cannot be determined.

License

© silverwind, distributed under BSD licence

Similar packages

Other packages similar to default-gateway

ip

The 'ip' package provides utilities for handling IP addresses, including the ability to parse and format them. While it doesn't offer direct functionality to find the default gateway, it complements 'default-gateway' by providing tools to work with the IP addresses that 'default-gateway' might return.

network

The 'network' package offers a broader range of network-related functionalities, including getting the user's IP address, gateway, and active network interfaces. It serves a similar purpose to 'default-gateway' but with additional features that might be useful for more comprehensive network programming tasks.

os

While not a third-party package but a core Node.js module, 'os' provides basic operating system-related utility functions. It includes methods to retrieve network interface details. However, it does not directly provide the default gateway information, making 'default-gateway' a necessary complement for specific gateway-related tasks.