JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 11332926
  • Score
    100M100P100Q210361F
  • License BSD-2-Clause

Get the default network gateway, cross-platform.

Package Exports

  • default-gateway
  • default-gateway/win32

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (default-gateway) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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