UNPKG

is-in-subnet

Version:

Check if an IPv4 or IPv6 address is contained in the given CIDR subnet

github.com/natesilva/is-in-subnet

natesilva/is-in-subnet

34 lines (33 loc) • 1.69 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
import * as IPv4 from './ipv4'; import * as IPv6 from './ipv6'; export { isIP, isIPv4, isIPv6 } from './util'; export { IPv4, IPv6 }; /** * Test if the given IP address is contained in the specified subnet. * @param address the IPv4 or IPv6 address to check * @param subnet the IPv4 or IPv6 CIDR to test (or an array of them) * @throws if any of the address or subnet(s) are not valid IP addresses, or the CIDR * prefix length is not valid */ export declare function isInSubnet(address: string, subnetOrSubnets: string | string[]): boolean; /** * Create a function to test if the given IP address is contained in the specified subnet. * @param subnet the IPv4 or IPv6 CIDR to test (or an array of them) * @throws if any of the subnet(s) are not valid IP addresses, or the CIDR * prefix length is not valid */ export declare function createChecker(subnetOrSubnets: string | string[]): (address: string) => boolean; /** Test if the given IP address is a private/internal IP address. */ export declare function isPrivate(address: string): boolean; /** Test if the given IP address is a localhost address. */ export declare function isLocalhost(address: string): boolean; /** Test if the given IP address is an IPv4 address mapped onto IPv6 */ export declare function isIPv4MappedAddress(address: string): boolean; /** Test if the given IP address is in a known reserved range and not a normal host IP */ export declare function isReserved(address: string): boolean; /** * Test if the given IP address is a special address of any kind (private, reserved, * localhost) */ export declare function isSpecial(address: string): boolean; export declare const check: typeof isInSubnet;