Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: remove outdated sentence #54963

Closed
wants to merge 1 commit into from
Closed

Conversation

lpinca
Copy link
Member

@lpinca lpinca commented Sep 16, 2024

The 'IPv4' and 'IPv6' values are no longer supported.

Fixes: #54961

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/net

@nodejs-github-bot nodejs-github-bot added dns Issues and PRs related to the dns subsystem. doc Issues and PRs related to the documentations. labels Sep 16, 2024
doc/api/dns.md Outdated Show resolved Hide resolved
The `'IPv4'` and `'IPv6'` values are no longer supported.

Fixes: nodejs#54961
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add an entry in the YAML list?

@aduh95 aduh95 added the lts-watch-v18.x PRs that may need to be released in v18.x. label Sep 16, 2024
@lpinca
Copy link
Member Author

lpinca commented Sep 16, 2024

The current documentation is correct

$ ./node
Welcome to Node.js v23.0.0-pre.
Type ".help" for more information.
> dns.lookup('example.com', { family: 'IPv4' }, function (err, result) { console.log(result) })
GetAddrInfoReqWrap {
  callback: [Function (anonymous)],
  family: 4,
  hostname: 'example.com',
  oncomplete: [Function: onlookup]
}
> 93.184.215.14

The 'IPv4' and 'IPv6' values are not supported in the promise returning variant, but that is also correctly documented.

@lpinca lpinca closed this Sep 16, 2024
@lpinca lpinca deleted the fix/issue-54961 branch September 16, 2024 12:42
@RedYetiDev
Copy link
Member

However the deprecation has reached End-Of-Life per #41431, so maybe that behavior should be changed?

@aduh95
Copy link
Contributor

aduh95 commented Sep 16, 2024

See #43054. It might make sense to update deprecations.md to clarify dns.lookup is no longer in scope.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dns Issues and PRs related to the dns subsystem. doc Issues and PRs related to the documentations. lts-watch-v18.x PRs that may need to be released in v18.x.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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