Gathering detailed insights and metrics for range_check
Check if a IPv4 and/or IPv6 is within a range
Installations
npm install range_checkDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS, ESM
Node Version
22.4.1
NPM Version
10.8.1
Score
99.6
Supply Chain
99.5
Quality
78.3
Maintenance
100
Vulnerability
99.6
License
Releases
Unable to fetch releases
Contributors
3
Unable to fetch Contributors
Languages
1
TypeScript
TypeScript (100%)
Developer
keverw
Download Statistics
Total Downloads
19,426,504
Last Day
10,651
Last Week
63,501
Last Month
318,104
Last Year
4,357,981
GitHub Statistics
58 Stars
74 Commits
17 Forks
7 Watching
1 Branches
3 Contributors
Bundle Size
17.38 kB
Minified
5.12 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
3.2.0
Package Id
range_check@3.2.0
Unpacked Size
20.28 kB
Size
5.72 kB
File Count
7
NPM Version
10.8.1
Node Version
22.4.1
Publised On
19 Jul 2024
Total Downloads
Cumulative downloads
Total Downloads
19,426,504
Last day
45.1%
10,651
Compared to previous day
Last week
-10.3%
63,501
Compared to previous week
Last month
1.7%
318,104
Compared to previous month
Last year
3.1%
4,357,981
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
Range Check v3.1.0
 
This is a simple module to validate IP address, check IP address version, check if IP is within a range.
This started out as range_check but it does much more than just checking ranges but since it's already got a large amount of downloads (37,115 downloads in the last month as of this writing) I'll keep the name the same even though I kinda want to change it to something better.
Install
npm install range_check or yarn add range_check
You can then import the functions as needed or require the entire range_check package depending on your own projects configuration.
IP Functions
Check if IP is valid
1console.log(isIP('10.0.1.5')); //returns true or false
Check IP version
Version
1console.log(version('10.0.1.5')); //returns 4 2console.log(version('2001:4860:8006::62')); //returns 6 3console.log(version('foo')); //returns 0 as invalid IP address
isV4
1console.log(isV4('10.0.1.5')); //true 2console.log(isV4('foo')); //false 3console.log(isV4('123::123')); //false
isV6
1console.log(isV6('123::123')); //true 2console.log(isV6('foo')); //false 3console.log(isV6('10.0.1.5')); //false
Range Functions
Check if range is valid
You can use isRange if you want to validate an entire range.
1console.log(isRange('2001:db8::/32')); //true 2console.log(isRange('10.0.0.0/8')); // true 3console.log(isRange('qwerty')); // false 4
Check if IP is within range
1console.log(inRange('10.0.1.5', '10.0.0.0/8')); //returns true 2 3console.log(inRange('192.0.1.5', '10.0.0.0/8')); //returns false 4 5console.log(inRange('2001:db8:1234::1', '2001:db8::/32')); //returns true
You can also give a list of ranges
1console.log(inRange('192.168.1.1', ['10.0.0.0/8', '192.0.0.0/8'])); //returns true 2
Check if IP is private
1console.log(isPrivateIP('10.0.0.1')); //returns true 2console.log(isPrivateIP('192.168.1.1')); //returns true 3console.log(isPrivateIP('172.16.0.1')); //returns true 4console.log(isPrivateIP('8.8.8.8')); //returns false 5console.log(isPrivateIP('fd00::1')); //returns true (IPv6 ULA) 6console.log(isPrivateIP('2001:db8::1')); //returns false
This function checks if an IP address is private. It returns true for:
- IPv4 private ranges (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16)
- IPv4 loopback addresses (127.0.0.0/8)
- IPv6 unique local addresses (fd00::/8)
- IPv6 loopback address (::1)
Check if IP is in range or private
1console.log(isIPInRangeOrPrivate('192.168.1.1')); // returns true (private IP) 2console.log(isIPInRangeOrPrivate('8.8.8.8')); // returns false (public IP, no range specified) 3console.log(isIPInRangeOrPrivate('8.8.8.8', { ranges: '8.8.8.0/24' })); // returns true 4console.log(isIPInRangeOrPrivate('10.0.0.1', { allowAnyPrivate: false, ranges: '8.8.8.0/24' })); // returns false
This function checks if an IP address is either within a specified range or is a private IP. It's particularly useful for scenarios where you need to determine if a request is coming from a local server or a specific set of allowed IPs.
Options:
ranges: A string or array of strings representing IP ranges to check against.allowAnyPrivate: Boolean to determine if any private IP should be allowed. Defaults to true.
If no options are provided, the function will return true for any private IP and false for public IPs.
Use case example: This function can be used in server configurations to easily allow local calls or calls from specific IP ranges, while blocking others. For instance, it can be used in middleware for setting trace IDs. This allows you to automatically set trace IDs for requests from private networks or specific IP ranges, which can be useful for debugging and tracking requests across microservices in a distributed system.
storeIP
This function is useful to get a consistent IP address such for storing it in a database or when searching in a database after being stored using this. So if a V6 address was sent compacted or not, or if you searched by either version this function would make sure you get a consistent IP address for both versions. Also the possibly of saving a few bytes.
If an V6 addressed is mapped as v4 is given it will convert it to V4, If any other V6 address is given it is abbreviated and plain V4 addresses are left alone. Returns null if a invalid IP
1console.log(storeIP('foo')); //null 2console.log(storeIP('::ffff:127.0.0.1')); //127.0.0.1 3console.log(storeIP('2001:0000:0111:0000:0011:0000:0001:0000')); //2001:0:111:0:11:0:1:0 4console.log(storeIP('2001:0001:0000:0001:0000:0000:0000:0000')); //2001:1:0:1:: 5console.log(storeIP('0000:0000:0000:0000:0000:0000:0000:0000')); //:: 6console.log(storeIP('0000:0000:0000:0000:0000:0000:0000:0001')); //::1 7console.log(storeIP('2041:0000:140F:0000:0000:0000:875B:131B')); //2041:0:140F::875B:131B 8console.log(storeIP('2001:0001:0002:0003:0004:0005:0006:0007')); //2001:1:2:3:4:5:6:7 9console.log(storeIP('127.0.0.1')); //127.0.0.1
searchIP
Same function as storeIP, just a clearer name when you are using it for search instead
displayIP
This function is useful for displaying IP addresses, such as after grabbing it back from the database when using storeIP
If an V6 addressed mapped as v4 is given it will convert it to V4, If any other V6 address is given it is normalized into the longer version and plain V4 addresses are left alone. Returns a empty string if a invalid IP
1console.log(displayIP(null)); // '' 2console.log(displayIP('::ffff:127.0.0.1')); //'127.0.0.1' 3console.log(displayIP('2001:0:111:0:11:0:1:0')); //'2001:0000:0111:0000:0011:0000:0001:0000' 4console.log(displayIP('2001:1:0:1::')); //'2001:0001:0000:0001:0000:0000:0000:0000' 5console.log(displayIP('::')); //'0000:0000:0000:0000:0000:0000:0000:0000' 6console.log(displayIP('::1')); //'0000:0000:0000:0000:0000:0000:0000:0001' 7console.log(displayIP('2041:0:140F::875B:131B')); //'2041:0000:140F:0000:0000:0000:875B:131B' 8console.log(displayIP('2001:1:2:3:4:5:6:7')); //'2001:0001:0002:0003:0004:0005:0006:0007' 9console.log(displayIP('127.0.0.1')); //'127.0.0.1' 10
Contributing
This project is using this starter library bun-lib-starter
Currently to use NPM to publish, must have that installed with Node, along side Bun
1cd into the repo 2 3pre-commit install 4 5bun install
bun run test: Run test suitebun run build: Generate bundles and typingsbun run format: Format source files, readme, etc
Dependencies
- ipaddr.js - https://github.com/whitequark/ipaddr.js
- ip6 - https://github.com/elgs/ip6
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
Found 1/17 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 14 are checked with a SAST tool
Score
3
/10
Last Scanned on 2025-01-06
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More