Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inDemoInstall

default-gateway

Package Overview
Dependencies
1
Maintainers
1
Versions
49
Issues
File Explorer

Advanced tools

default-gateway

Get the default network gateway, cross-platform.

    6.0.3latest
    Github

Version published
Maintainers
1
Weekly downloads
12,810,648
increased by8.87%

Weekly downloads

Readme

Source

default-gateway

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 Windows, wmic must be available.
  • On IBM i, the db2util command must be available (provided by the db2util package).
  • On Unix (and macOS), the netstat command must be available.

Installation

$ npm i 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

Keywords

FAQs

What is default-gateway?

Get the default network gateway, cross-platform.

Is default-gateway popular?

The npm package default-gateway receives a total of 12,305,393 weekly downloads. As such, default-gateway popularity was classified as popular.

Is default-gateway well maintained?

We found that default-gateway demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 11 Jan 2021

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket[email protected]

Product

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc