Interface StringifyOptions

Options for formatting IP address output.

interface StringifyOptions {
    capitalize?: boolean;
    format?: "default" | "short" | "long";
    mode?: "short" | "long";
}

Hierarchy (view full)

StringifyOptions
- IPOptions

Index

Properties

capitalize? format? mode?

Properties

`Optional`capitalize

capitalize?: boolean

Whether to convert output to uppercase (applies to IPv6 hex segments).

`Optional`format

format?: "default" | "short" | "long"

Address formatting style:

'default' (default):
- IPv4 returns sanitized form (e.g., 192.168.0.1)
- IPv6 returns condensed form without aggressive shortening (e.g., fd12:3456:789a:1:0:0:0:0)
'short': Aggressive shortening for IPv6 using :: per RFC 5952.
- IPv4 unchanged from default.
'long': Full zero-padded form.
- IPv4: 192.168.000.001
- IPv6: fd12:3456:789a:0001:0000:0000:0000:0000

`Optional`mode

mode?: "short" | "long"

Use format instead.

Deprecated