Socket
Socket
Sign inDemoInstall

default-gateway

Package Overview
Dependencies
16
Maintainers
1
Versions
54
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    default-gateway

Get the default network gateway, cross-platform.


Version published
Maintainers
1
Install size
225 kB
Created

Package description

What is default-gateway?

The default-gateway npm package provides a simple and efficient way to find the default gateway of the local machine's network interfaces. It supports multiple operating systems, including Windows, macOS, and Linux, making it a versatile tool for network-related programming tasks. This package can be particularly useful for applications that need to interact with the network layer of the operating system, such as determining the best route for network traffic or configuring network settings programmatically.

What are default-gateway's main functionalities?

Finding the default gateway for IPv4

This feature allows you to asynchronously find the default IPv4 gateway of the local machine. The result is an object containing the gateway's IP address and the associated network interface.

const defaultGateway = require('default-gateway');
defaultGateway.v4().then(result => console.log(result));

Finding the default gateway for IPv6

Similar to the IPv4 feature, this allows for the asynchronous discovery of the default IPv6 gateway. The result includes the IPv6 gateway address and the network interface it is associated with.

const defaultGateway = require('default-gateway');
defaultGateway.v6().then(result => console.log(result));

Other packages similar to default-gateway

Readme

Source

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

© silverwind, distributed under BSD licence

FAQs

Last updated on 10 Jun 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc