format-str

Format strings skillfully

Install

$ npm install --save format-str

Example

const format = require("format-str");

let age = format("I am %i years old", 20);
console.log(age); // => I am 20 years old

let white = format("Color white is #%x%x%x", 255, 255, 255);
console.log(white); // => Color white is #ffffff

console.log(format("8 - 5 = %i", 8 - 5)); // => 8 - 5 = 3

API

Notation

%[<flags>][<width>][.<precision>]<modifier>

| Spec | Description | | ---- | ----------- | | flags | Flags for additional modification of the formatted value. | | width | The minimum width of the string. Takes positive numbers. | | precision | In modifier s, represents the number of characters to take; in mods i, o, and x, represents the minimum number of digits to appear; in mod x, represents the number of digits to appear after the decimal point. | | modifier | A modifier to format the argument. |

Specs in brackets are optional. To insert a literal %, use %%.

Flags

| Flag | Description | | ---- | ----------- | | # | Form the alternate form of the modifier. For o mod, prepend 0 if not started by it already. For x mod, prepend 0x if converted value is nonzero. For f mod, persistently add a decimal point. For other mods, throws an error. | | - | Left justify the argument. | | 0 | Prepend zeroes rather than blanks. Applies only on mods f, i, x, and o. Ineffective when - spec is used. |

Flags may be arranged in any order.

Modifiers

| Modifier | Description | | -------- | ----------- | | f | Formats float or decimal numbers. In precision of 6 decimal places by default. | | s | Formats any type to string. Uses toString method. | | i | Formats integers. | | o | Formats integers in octal base. | | x | Formats integers in hexadecimal base. |

Tests

npm update
npm test