JarCasting
JarCasting JarCasting

default-gateway

WebJar for default-gateway

License

License

BSD 2-Clause
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

default-gateway
Last Version

Last Version

4.2.0
Release Date

Release Date
Type

Type

jar
Description

Description

default-gateway
WebJar for default-gateway
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/silverwind/default-gateway

Download default-gateway

Filename Size
default-gateway-4.2.0.pom
default-gateway-4.2.0.jar 11 KB
default-gateway-4.2.0-sources.jar 22 bytes
default-gateway-4.2.0-javadoc.jar 22 bytes
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/default-gateway/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>default-gateway</artifactId>
    <version>4.2.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/default-gateway/
implementation 'org.webjars.npm:default-gateway:4.2.0'
// https://jarcasting.com/artifacts/org.webjars.npm/default-gateway/
implementation ("org.webjars.npm:default-gateway:4.2.0")
'org.webjars.npm:default-gateway:jar:4.2.0'
<dependency org="org.webjars.npm" name="default-gateway" rev="4.2.0">
  <artifact name="default-gateway" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='default-gateway', version='4.2.0')
)
libraryDependencies += "org.webjars.npm" % "default-gateway" % "4.2.0"
[org.webjars.npm/default-gateway "4.2.0"]

Dependencies

compile (2)

Group / Artifact Type Version
org.webjars.npm : execa jar [1.0.0,2)
org.webjars.npm : ip-regex jar [2.1.0,3)

Project Modules

There are no modules declared in this project.

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

Versions

Version
4.2.0