Interface CompareOptions

Options for comparing IP inputs.

interface CompareOptions {
    excludeEquivalent?: boolean;
}

Properties

excludeEquivalent?: boolean

Whether to exclude equivalent IP addresses from being treated as matching in IP comparison methods.

For example, IPUtil.contains returns true by default when two equivalent IP strings are compared (i.e., this option defaults to false):

IPUtil.contains('fd12:3456:789a:1::/64', 'fd12:3456:789a:1:0:0:0:0/64'); // true

If this option is set to true, the comparison above will return false instead, since identical CIDRs are not considered to form a containment relationship in that case.