doc: add esm examples to node:util

[mfdebian]

This PR adds the missing ESM counterparts of the CJS examples for the Util documentation.

I also destructured the (require) imports for the current CJS examples following a feedback I had received in previous PRs.

For the numericSeparator example of util.inspect(object[, showHidden[, depth[, colors]]]) I took the liberty to leave the numbers like this:

const thousand = 1000;
const million = 1000000;
...

Instead of:

const thousand = 1_000;
const million = 1_000_000;
...

Because that's actually what we want to showcase, how numericSeparator would add the missing underscores to print:

1_000
1_000_000
...

For the Box and util.inspect.custom examples at Custom inspection functions on objects I added a final console.log so users don't have to add it themselves when copy/pasting the example to see an output.

For the util.inspect.defaultOptions example I incremented the number of 0's to be added just so the output is more dramatic and it would showcase the function better imo, it would also print a square on the terminal which looks pretty awesome:

[
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0,
  ... 56 more items
]
[
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
]

For the promisify() class methods that use this example at util.promisify(original), the one with:

class Foo {
  constructor() {
    this.a = 42;
  }

  bar(callback) {
    callback(null, this.a);
  }
}
...

I updated the error message, since now it's: TypeError: Cannot read properties of undefined (reading 'a') instead of TypeError: Cannot read property 'a' of undefined.

Lastly, for the util.styleText(format, text[, options]) there was a typo on the example that recently got fixed but only for the ESM part, this adds the CJS fix for that typo.

I think that's all, tell me what you think and I can update/change things around!

I've tested every single example and they all work/behave as expected.

As always, best regards 💚

Edit:
For the util.deprecate(fn, msg[, code]) example (the second one) I also added the functions and messages so users can just copy/paste that portion of code and run it without encountering errors.

[AugustinMauroy]

Why do we need destructed object ?

[mfdebian]

Hello @AugustinMauroy sorry I took so long to answer, I was on vacation.

That's a feedback I received from other maintainers as I've been updating the docs to ensure all examples from the API docs have both their csj and esm counterparts.

Most esm examples were already destructured, and the idea is that the csj counterparts don't differ from the esm ones, that way new and upcoming Node.js users don't get confused and it shows that the main difference is about the way we import libraries but not what we're importing. We've already been doing it for the other docs 😊

Thanks for your review! 🙌 tell me if you have any more questions or wish to ask for a change!

[AugustinMauroy]

LGMT !

[lpinca]

RSLGTM

[nodejs-github-bot]

Landed in c05f4ba