[node:util] format is optional in util.format?

[Semigradsky]

Affected URL(s)

https://nodejs.org/docs/latest-v18.x/api/util.html#utilformatformat-args

Description of the problem

By https://nodejs.org/docs/latest-v18.x/api/util.html#utilformatformat-args has required string argument util.format.

But in examples we see:

If the first argument does not contain a valid format specifier, util.format() returns a string that is the concatenation of all arguments separated by spaces:

util.format(1, 2, 3);
// Returns: '1 2 3'

Looks like it the same as having optional format argument.
So it shoud be util.format([format [, ...args]]) instead of util.format(format[, ...args]).

[Semigradsky]

The same for util.formatWithOptions.

[aduh95]

Do you want to send a PR to fix this?

[BridgeAR]

The intention is to always have a format argument. If it does not contain a formatter, that's still valid.
The suggestion above util.format([format [, ...args]]) actually means no arguments at all is valid and that would print an empty string but it's also not the intended use.

[Semigradsky]

util.format([format], [...args]) maybe?

There are two options:

1. You can pass format and args: in this case arguments will be formatted by format.
2. You can pass only args: in this case default formatter is used (returns a string that is the concatenation of all arguments separated by spaces)

util.format('%s:%s', 'foo') - 1
util.format(1, 2, 3) - 2
util.format('%s:%s') - 2
util.format() - 2 // not the intended use, but in fact, works and returns an empty string as expected

[daltonna]

Could @Semigradsky @VoltrexKeyva or someone else assign this issue to me? I have some ideas for a fix.

[Semigradsky]

@daltonna jsut send PR?

[BridgeAR]

I don't really believe this is an issue. Since no one picked this up, I am going to close it