doc: fix outdated documentation for family property

[aduh95]

I forgot to update the docs in a few places when working on #41431.
Fixes: #42787

[nodejs-github-bot]

Review requested:

• @nodejs/net

[bl-ue]

I'm not sure if it should be done in this PR, but I believe the following tests should be updated as well:

• test/parallel/test-net-remote-address-port.js
• test/parallel/test-dgram-udp6-link-local-address.js
• test/internet/test-dgram-multicast-set-interface-lo.js
• test/common/report.js

[aduh95]

• test/parallel/test-net-remote-address-port.js

FYI remoteFamily is still returning a string (which is arguably confusing, but I also didn't want to introduce another unnecessary breaking change).

• test/parallel/test-dgram-udp6-link-local-address.js

Good catch, do you want to submit a PR?

node/test/parallel/test-dgram-udp6-link-local-address.js

Line 15 in 1e76165

if(family==='IPv6'&&address.startsWith('fe80:')){

• test/internet/test-dgram-multicast-set-interface-lo.js
• test/common/report.js

AFAICT those are not related to this change (I've tried to update them in the original PR, but had to revert the changes because they were no longer passing).

[bnoordhuis]

Can I suggest to undo the string -> number change? It's caused at least one regression in a popular package (ref) and I expect it's not going to be the only one.

[davecarlson]

Can I suggest to undo the string -> number change? It's caused at least one regression in a popular package (ref) and I expect it's not going to be the only one.

The change is fine, and is benefitial.

It's in a Major release, and we are to expect some breaking changes (infact, majors are where the breakings are allowed!).
If it's an issue, stay on 16/17 until deps are updated

[ShogunPanda]

LGTM!

[RaisinTen]

Can I suggest to undo the string -> number change? It's caused at least one regression in a popular package (ref) and I expect it's not going to be the only one.

+1. I think we do breaking changes (even in major releases) only when the usage goes down in the npm ecosystem as a result of the runtime deprecation warning.

[aduh95]

Note that reverting the string -> number change would be itself a breaking change at this point. If someone wants to revert it, I would advise them to open a PR ASAP, the more we wait the more users will start depending on the new behavior.

[nodejs-github-bot]

Landed in 4ad342a

[osiris-plus]

@aduh95 the documentation website still shows outdated information:
https://nodejs.org/docs/latest-v18.x/api/os.html#osnetworkinterfaces

[aduh95]

The docs are correct, it's been reverted in v18.4.0 by #43054.

[osiris-plus]

I'm sorry, my distro is lagging behind it seems.