History

赵凯迪 2084901906 frist commit		4 months ago
..
LICENSE	frist commit	4 months ago
README.md	frist commit	4 months ago
android.js	frist commit	4 months ago
darwin.js	frist commit	4 months ago
freebsd.js	frist commit	4 months ago
ibmi.js	frist commit	4 months ago
index.js	frist commit	4 months ago
linux.js	frist commit	4 months ago
openbsd.js	frist commit	4 months ago
package.json	frist commit	4 months ago
sunos.js	frist commit	4 months ago
win32.js	frist commit	4 months ago

README.md

default-gateway

Get the default network gateway, cross-platform.

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

Installation

$ npm install default-gateway

Example

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

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

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

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

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

API

defaultGateway.v4()

defaultGateway.v6()

defaultGateway.v4.sync()

defaultGateway.v6.sync()

Returns: result Object

gateway: The IP address of the default gateway.
interface: The name of the interface. On Windows, this is the network adapter name.

The .v{4,6}() methods return a Promise while the .v{4,6}.sync() variants will return the result synchronously.

The gateway property will always be defined on success, while interface can be null if it cannot be determined. All methods reject/throw on unexpected conditions.