Socket
Socket
Sign inDemoInstall

internal-ip

Package Overview
Dependencies
31
Maintainers
1
Versions
20
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

internal-ip

Get your internal IP address


Version published
Maintainers
1
Weekly downloads
3,399,718
decreased by-9.37%

Weekly downloads

Package description

What is internal-ip?

The internal-ip npm package is designed to retrieve the internal IP address of a system. It can fetch both IPv4 and IPv6 addresses and works across different operating systems. This package is particularly useful for development environments where knowing the internal IP address is necessary for tasks such as network configuration or services that need to bind to the internal IP rather than localhost.

What are internal-ip's main functionalities?

Get IPv4 address

This feature allows you to asynchronously retrieve the IPv4 address of the system. The example demonstrates how to import the package, use the v4 method, and log the result.

const internalIp = require('internal-ip');

(async () => {
  console.log(await internalIp.v4());
  //=> '10.0.0.79'
})();

Get IPv6 address

This feature enables the asynchronous retrieval of the system's IPv6 address. The code sample shows how to use the v6 method to get the IPv6 address and log it.

const internalIp = require('internal-ip');

(async () => {
  console.log(await internalIp.v6());
  //=> 'fe80::1'
})();

Other packages similar to internal-ip

Readme

Source

internal-ip

Get your internal IP address

Install

npm install internal-ip

Usage

import {internalIpV6, internalIpV4} from 'internal-ip';

console.log(await internalIpV6());
//=> 'fe80::1'

console.log(await internalIpV4());
//=> '10.0.0.79'

API

The package returns the address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, undefined will be returned.

The package relies on operating systems tools. On Linux and Android, the ip command must be available, which depending on distribution might not be installed by default. It is usually provided by the iproute2 package. internalIpV6Sync() and internalIpV4Sync() are not supported in browsers and just return undefined.

internalIpV6()

Returns the internal IPv6 address asynchronously.

internalIpV4()

Returns the internal IPv4 address asynchronously.

internalIpV6Sync()

Returns the internal IPv6 address synchronously.

internalIpV4Sync()

Returns the internal IPv4 address synchronously.

  • internal-ip-cli - CLI for this package
  • public-ip - Get your public IP address
  • default-gateway - Get your default gateway address

Keywords

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