util.format(format[, ...])
Returns a formatted string using the first argument as a printf
-like format.
The first argument is a string that contains zero or more placeholders. Each placeholder is replaced with the converted value from its corresponding argument. Supported placeholders are:
-
%s
- String. -
%d
- Number (both integer and float). -
%j
- JSON. Replaced with the string'[Circular]'
if the argument contains circular references. -
%%
- single percent sign ('%'
). This does not consume an argument.
If the placeholder does not have a corresponding argument, the placeholder is not replaced.
util.format('%s:%s', 'foo'); // 'foo:%s'
If there are more arguments than placeholders, the extra arguments are coerced to strings (for objects and symbols, util.inspect()
is used) and then concatenated, delimited by a space.
util.format('%s:%s', 'foo', 'bar', 'baz'); // 'foo:bar baz'
If the first argument is not a format string then util.format()
returns a string that is the concatenation of all its arguments separated by spaces. Each argument is converted to a string with util.inspect()
.
util.format(1, 2, 3); // '1 2 3'
Please login to continue.