https://github.com/sindresorhus/internal-ip

Get your internal IP address
https://github.com/sindresorhus/internal-ip

Last synced: about 9 hours ago
JSON representation

Get your internal IP address

• Host: GitHub
• URL: https://github.com/sindresorhus/internal-ip
• Owner: sindresorhus
• License: mit
• Created: 2014-09-14T20:43:27.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2024-11-10T07:36:16.000Z (about 1 month ago)
• Last Synced: 2024-12-04T21:33:36.846Z (8 days ago)
• Language: JavaScript
• Homepage:
• Size: 87.9 KB
• Stars: 334
• Watchers: 9
• Forks: 27
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-nodejs - internal-ip - Get your internal IP address.  (Repository / Network)
• awesome-npm - internal-ip - 获取IP地址 (4. 工具 / 4.2 系统相关)

README

        
# internal-ip

> Get your internal IP address

## Install

```sh

npm install internal-ip

```

## Usage

```js

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.

## Related

- [internal-ip-cli](https://github.com/sindresorhus/internal-ip-cli) - CLI for this package

- [public-ip](https://github.com/sindresorhus/public-ip) - Get your public IP address

- [default-gateway](https://github.com/silverwind/default-gateway) - Get your default gateway address