function isAddressv4Documentation
isAddressv4Documentation(address: number): boolean

Checks if an IPv4 address is in a documentation range (RFC 5737).

Documentation ranges:

  • 192.0.2.0/24 (TEST-NET-1)
  • 198.51.100.0/24 (TEST-NET-2)
  • 203.0.113.0/24 (TEST-NET-3)

Examples

Example 1

import { assert, assertEquals } from "@std/assert";
import { isAddressv4Documentation } from "@hertzg/ip/classifyv4";
import { parseAddressv4 } from "@hertzg/ip/addressv4";

assert(isAddressv4Documentation(parseAddressv4("192.0.2.1").address));
assert(isAddressv4Documentation(parseAddressv4("198.51.100.1").address));
assert(isAddressv4Documentation(parseAddressv4("203.0.113.1").address));
assertEquals(isAddressv4Documentation(parseAddressv4("192.0.3.0").address), false);

Parameters

address: number

The address as a 32-bit unsigned integer

Return Type

boolean

true if the address is in a documentation range

Usage

import { isAddressv4Documentation } from "classifyv4.ts";