Usage in Deno
import { format } from "node:util";
format(format?: any,...param: any[],): string
The util.format()
method returns a formatted string using the first argument
as a printf
-like format string which can contain zero or more format
specifiers. Each specifier is replaced with the converted value from the
corresponding argument. Supported specifiers are:
If a specifier does not have a corresponding argument, it is not replaced:
util.format('%s:%s', 'foo'); // Returns: 'foo:%s'
Values that are not part of the format string are formatted usingutil.inspect()
if their type is not string
.
If there are more arguments passed to the util.format()
method than the
number of specifiers, the extra arguments are concatenated to the returned
string, separated by spaces:
util.format('%s:%s', 'foo', 'bar', 'baz'); // Returns: 'foo:bar baz'
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'
If only one argument is passed to util.format()
, it is returned as it is
without any formatting:
util.format('%% %s'); // Returns: '%% %s'
util.format()
is a synchronous method that is intended as a debugging tool.
Some input values can have a significant performance overhead that can block the
event loop. Use this function with care and never in a hot code path.
string