dns.lookup options..family throw errors when using 'IPv4'

[tomek3e]

Version

v22.4.0

Platform

Microsoft Windows NT 10.0.19045.0 x64

Subsystem

dns

What steps will reproduce the bug?

import dns from 'node:dns/promises';

async function dnsLookup(){
await dns.lookup("localhost", {family: 'IPv4' })
}

dnsLookup()

How often does it reproduce? Is there a required condition?

Always

What is the expected behavior? Why is that the expected behavior?

Function not to throw.

What do you see instead?

Throws
TypeError: The property 'options.family' must be one of: 0, 4, 6. Received 'IPv4'

Additional information

Same happens on v20.14.0, v18.18.0.
According to the documentation IPv4 and IPv6 should be accepted https://nodejs.org/docs/latest-v22.x/api/dns.html#dnslookuphostname-options-callback

family | The record family. Must be 4, 6, or 0. For backward compatibility reasons,'IPv4' and 'IPv6' are interpreted as 4 and 6 respectively. The value 0 indicates that either an IPv4 or IPv6 address is returned. If the value 0 is used with { all: true } (see below), either one of or both IPv4 and IPv6 addresses are returned, depending on the system's DNS resolver. Default: 0.

[climba03003]

It is expected to removed since the start of node@18.
So, the problems is related to document is not up-to-date.

Reference #41431

[lpinca]

The documentation is ok. The value 'IPv4' and 'IPv6' are supported in the callback variant of dns.lookup().

[tomek3e]

@lpinca Indeed, upon checking https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options it is indeed unsupported.
It is however incorrectly documented in @types/node/dns/promises.d.ts which uses LookupOptions interface from the callback version.

declare module "dns/promises" {
import {
...,
LookupOptions,
....
} from "node:dns";

[lpinca]

@tomek3e that should be fixed in the DefinitelyTyped repository.