You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
4 months ago | |
|---|---|---|
| .. | ||
| node_modules | 4 months ago | |
| LICENSE | 4 months ago | |
| README.md | 4 months ago | |
| android.js | 4 months ago | |
| darwin.js | 4 months ago | |
| freebsd.js | 4 months ago | |
| ibmi.js | 4 months ago | |
| index.js | 4 months ago | |
| linux.js | 4 months ago | |
| openbsd.js | 4 months ago | |
| package.json | 4 months ago | |
| sunos.js | 4 months ago | |
| win32.js | 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
ipcommand must be available (usually provided by theiproute2package). - On Windows,
wmicmust be available. - On IBM i, the
db2utilcommand must be available (provided by thedb2utilpackage). - On Unix (and macOS), the
netstatcommand must be available.
Installation
$ npm install default-gateway
Example
const defaultGateway = require('default-gateway');
const {gateway, interface} = await defaultGateway.v4();
// gateway = '1.2.3.4', interface = 'en1'
const {gateway, interface} = await defaultGateway.v6();
// gateway = '2001:db8::1', interface = 'en2'
const {gateway, interface} = defaultGateway.v4.sync();
// gateway = '1.2.3.4', interface = 'en1'
const {gateway, interface} = defaultGateway.v6.sync();
// 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.
License
© silverwind, distributed under BSD licence