https://github.com/cityssm/is-private-network-address

Determines whether traffic is from a private or internal IP address.
https://github.com/cityssm/is-private-network-address

address hacktoberfest internet ip-address ipv4 ipv6 local localhost network private subnet

Last synced: 11 months ago
JSON representation

Determines whether traffic is from a private or internal IP address.

• Host: GitHub
• URL: https://github.com/cityssm/is-private-network-address
• Owner: cityssm
• License: mit
• Created: 2021-05-12T13:42:19.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-12-02T20:49:01.000Z (over 1 year ago)
• Last Synced: 2024-12-06T18:50:25.340Z (over 1 year ago)
• Topics: address, hacktoberfest, internet, ip-address, ipv4, ipv6, local, localhost, network, private, subnet
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@cityssm/is-private-network-address
• Size: 570 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# is-private-network-address

[![npm (scoped)](https://img.shields.io/npm/v/@cityssm/is-private-network-address)](https://www.npmjs.com/package/@cityssm/is-private-network-address)

[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/cityssm/is-private-network-address)](https://codeclimate.com/github/cityssm/is-private-network-address)

[![DeepSource](https://app.deepsource.com/gh/cityssm/is-private-network-address.svg/?label=active+issues&show_trend=true&token=Ig0hw1im4uCKenMzR6Serqdm)](https://app.deepsource.com/gh/cityssm/is-private-network-address/)

[![codecov](https://codecov.io/gh/cityssm/is-private-network-address/graph/badge.svg?token=HK5N4A5N2F)](https://codecov.io/gh/cityssm/is-private-network-address)

[![Coverage Testing](https://github.com/cityssm/is-private-network-address/actions/workflows/coverage.yml/badge.svg)](https://github.com/cityssm/is-private-network-address/actions/workflows/coverage.yml)

Determines whether or not a network address is a private or internal.

Supports all [Reserved IP Addresses](https://en.wikipedia.org/wiki/Reserved_IP_addresses)

used for private networks.

## Installation

```sh

npm install @cityssm/is-private-network-address

```

## Usage

```javascript

import { isLocal, isPrivate } from "@cityssm/is-private-network-address";

/* Test Local IPs */

console.log(isLocal("127.0.0.1"));

// => true

console.log(isLocal("::1"));

// => true

console.log(isLocal("12.34.56.78"));

// => false

/* Test Private IPs */

console.log(isPrivate("10.0.100.100"));

// => true

console.log(isPrivate("192.168.2.1"));

// => true

```