athea
Repositories Projects Packages

default-gateway (6.0.3)

Published 2026-02-24 13:55:17 +00:00 by atheaadmin

Installation

registry=
npm install default-gateway@6.0.3
"default-gateway": "6.0.3"

About this package

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

Dependencies

Dependencies

ID Version
execa ^5.0.0

Development Dependencies

ID Version
eslint 7.17.0
eslint-config-silverwind 27.0.0
jest 26.6.3
updates 11.4.2
versions 8.4.4

Keywords

default gateway network default gateway routing route
Details
npm
2026-02-24 13:55:17 +00:00
1
silverwind
Project Site
BSD-2-Clause
latest
4.3 KiB
Assets (1)
default-gateway-6.0.3.tgz 4.3 KiB
Versions (1) View all
6.0.3 2026-02-24