silverwind / default-gateway Goto Github PK

View Code? Open in Web Editor NEW

86.0 4.0 18.0 367 KB

Get the default network gateway, cross-platform.

Makefile 7.35% JavaScript 92.65%

nodejs module gateway cross-platform linux windows macos openbsd freebsd solaris

default-gateway's Introduction

default-gateway

Obtains the machine's default gateway through exec calls to OS routing ints.

On Linux and Android, the ip command must be available (usually provided by the iproute2 package).
On Unix (and macOS), the netstat command must be available.
On Windows, wmic must be available.
On IBM i, the db2util command must be available (provided by the db2util package).

Usage

import {gateway4async, gateway4sync, gateway6async, gateway6sync} from "default-gateway";

const {gateway, version, int} = await gateway4async();
// gateway = '1.2.3.4', version = 4, int = 'en1'

const {gateway, version, int} = await gateway6async();
// gateway = '2001:db8::1', version = 6,int = 'en2'

const {gateway, version, int} = gateway4sync();
// gateway = '1.2.3.4', version = 4, int = 'en1'

const {gateway, version, int} = gateway6sync();
// gateway = '2001:db8::1', version = 6, int = 'en2'

API

gateway4async()

gateway6async()

gateway4sync()

gateway6sync()

Returns: result Object

gateway String: The IP address of the default gateway.
version Number: The IP address version of gateway.
int String: The name of the interface. On Windows, this is the network adapter name.

The gateway property will always be defined on success, while int can be null if it cannot be determined. All methods reject/throw on unexpected conditions.

License

default-gateway's People

Contributors

Stargazers

Watchers

Forkers

ximet karli-sjoberg penggy oakaigh patrickhrastnik theprez bensjoberg puhui-team danetheory yniks surfndez vinhjaxt zhouzu iam-tj miaulightouch lumeweb jcc10

default-gateway's Issues

node version broken

{
"name": "default-gateway",
  "version": "5.0.4",
  "description": "Get the default network gateway, cross-platform.",
  "author": "silverwind <[email protected]>",
  "repository": "silverwind/default-gateway",
  "license": "BSD-2-Clause",
  "scripts": {
    "test": "eslint *.js && node --pending-deprecation --trace-deprecation --throw-deprecation --trace-warnings test.js"
  },
  "engines": {
    "node": ">=8"
  },
  "dependencies": {
    "execa": "^3.0.0"
  }
}

execa requires: "node": "^8.12.0 || >=9.7.0", but in your package node engines are "node": ">=8".
However, that does not match, please check it. Thanks.

Parse /proc instead of forking to ip for linux

Not all systems have ip installed, and you can just access data from /proc/net/route and /proc/net/ipv6_route directly.

Windows: The gateway is not from external card

When a computer has virtual network adapters with a gateway, it's selecting the first that finds, but not necessarily is the gateway of the external card.

Example: after run wmic path Win32_NetworkAdapterConfiguration where IPEnabled=true get DefaultIPGateway,Index /format:table in windows I get this response:

3 
{"0.0.0.0"} 5 
{"192.168.1.1", "fe80::dafb:5eff:fe33:3489"} 6 
8

and after parse it the result is 0.0.0.0, but the gateway of the external card is 192.168.1.1

Intention to deprecate this module

I intend to deprecate this module soon as I'm not willing to maintain it further because it's just a wrong approach overall to parse command output.

Affected users should look for alternatives. For webpack-dev-server, see my recommendation.

Respect metrics on all platforms

Currently, routing metrics are only respected on win32.

npm ERR! notsup Unsupported platform for [email protected]: wanted {"os":"darwin,linux,win32","arch":"any"} (current: {"os":"freebsd","arch":"x64"})
npm ERR! notsup Valid OS: darwin,linux,win32
npm ERR! notsup Valid Arch: any
npm ERR! notsup Actual OS: freebsd
npm ERR! notsup Actual Arch: x64

A little funny seeing how it´s BSD licensed :)

"interface" is a strict mode reserved keyword

according to this link,
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Strict_mode#paving_the_way_for_future_ecmascript_versions
interface is a reserved word to use in 'use strict';.

I ran into the node error with default example of destructuring
const {gateway, interface} = await defaultGateway.v4();
and had to go the const interface_v4 = gtw.interface way...

I would propose adding an alias of smth like interf to keep it backwards-compat. Alas it's not that big of a deal to skip the destructive sugar once.
Maybe a warning would be nice as well.

Question about docs

Hi, the docs say for the sync method that it should be:

const result = defaultGateway.v4().sync();
// result = {gateway: '1.2.3.4', interface: 'en1'}

const result = defaultGateway.v6().sync();
// result = {gateway: '2001:db8::1', interface: 'en2'}

But looking at the source, it is seems like it's supposed to be:

const result = defaultGateway.v4.sync();
// result = {gateway: '1.2.3.4', interface: 'en1'}

const result = defaultGateway.v6.sync();
// result = {gateway: '2001:db8::1', interface: 'en2'}

Is that right?

I confirm this by adding log to each $arch.js file.

My fix in my app is tiddly-gittly/TidGi-Desktop@abc699d

On windows if the adaptor name is in Chinese, result.interface failed to parse unicode adaptor name correctly.

version 5.0.0

When I use Chinese on adaptor name.

I changed the adaptor name in English.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.