package
sprintf parser and basic formatter
npm install sprintf-kitGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
npm install sprintf-kitParses format string into data map with respect to printf syntax
const parse = require("sprintf-kit/parse");
const data = parse("Some %s with %d count");
// `data` resolves with following content:
{
literals: ["Some ", " with ", " count"],
placeholders: [
{ type: "s", content: "%s" },
{ type: "d", content: "%d" }
],
isParameterIndexingValid: true
}data spec:
literals - Surrounding string literalsplaceholders - Meta data of parsed placholders.
Placeholder properties map (refer to spec for explanation of each property)
parameter - (optional) parameter setting (e.g. 1)flags - (optional) array of flags (e.g. ["0", "-"])width - (optional) width (e.g. 4 or "*" if dynamic)precision - (optional) precision (e.g. 4 or "*" if dynamic)length - (optional) length (e.g. "z")type - Modifier type (e.g. "s" or "d")content - Full string representation of placeholder (e.g. "%s")isParameterIndexingValid - Whether parameter indexing is valid across all placeholders.
e.g. if no placeholders come with parameters it'll be true. If some but not all of them will come with parameters, it'll be false (if used, then all placeholders should use them).// Configure format function that resolves 's' and 'd' modifiers
let format = require("sprintf-kit")({
d: require("sprintf-kit/modifiers/d"),
s: require("sprintf-kit/modifiers/s")
});
format("Some %s with %d count %x boo", "foo", 12, "ignored"); // Some foo with 12 count %x boo
// Special `rest` formater can be used to handle leftover arguments
format = require("sprintf-kit")({
d: require("sprintf-kit/modifiers/d"),
s: require("sprintf-kit/modifiers/s"),
rest: args => " " + args.
Resolver returns resolved data in form of object parts, which maybe helpful if additional programmatical processing is needed
// Configure format function that resolves 's' and 'd' modifiers
let resolve = require("sprintf-kit/get-resolver")({
d: require("sprintf-kit/modifiers/d"),
s: require("sprintf-kit/modifiers/s")
});
resolve("Some %s with %d count %x boo", "foo", 12, "ignored");
// {
// literals: ["Some ", " with ", " count ", " boo"],
// substitutions: [
// { value: "foo", placeholder: { type: "s", content: "%s" } },
// { value: "12", placeholder: { type: "d", content: "%d" } },
// { value: "%x", placeholder: { type: "x", content: "%x" }
// ],
// rest: null
// }
resolve = require("sprintf-kit/get-resolver")({
Currently just basic modifiers are configured in (PR's welcome to extend this support).
Modifiers can be found at sprintf-kit/modifiers folder.
Preconfigured modifiers
d - Numberf - Floating point valuei - Integerj - JSONs - StringEvery modifier is exception safe, in case of approaching invalid value, adequate error message token is displayed in place of placeholder
npm testProject cross-browser compatibility supported by:
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
Estimated unpacked size across 10 packages.
628.4 kB
Includes dependencies.