util-format-x

util-format-x

An implementation of node's util.format

Version: 1.3.0
Author: Xotic750 [e-mail]
License: MIT
Copyright: Xotic750

module.exports ⇒ * ⏏

The format() method returns a formatted string using the first argument as a printf-like format.

The first argument is a string containing zero or more placeholder tokens. Each placeholder token is replaced with the converted value from the corresponding argument. Supported placeholders are:

%s - String. %d - Number (integer or floating point value). %i - Integer. %f - Floating point value. %j - JSON. Replaced with the string '[Circular]' if the argument contains circular references. %% - single percent sign ('%'). This does not consume an argument.

Kind: Exported member
Returns: * - The target.

Param	Type	Description
f	string	Template.
[...args]	*	Values.

Example

var format = require('util-format-x');

// If the placeholder does not have a corresponding argument,
// the placeholder is not replaced.
format('%s:%s', 'foo'); // Returns: 'foo:%s'

// If there are more arguments passed to the format() method than the number
// of placeholders, the extra arguments are coerced into strings (for objects
// and symbols, inspect() is used) then concatenated to the returned
// string, each delimited by a space.
format('%s:%s', 'foo', 'bar', 'baz'); // 'foo:bar baz'

// If the first argument is not a format string then format() returns a
// string that is the concatenation of all arguments separated by spaces.
// Each argument is converted to a string using inspect().
format(1, 2, 3); // '1 2 3'

// If only one argument is passed to format(), it is returned as it is
//without any formatting.
format('%% %s'); // '%% %s'