BlueGit

blue-star danique-bot

Files

danique-bot / node_modules / extsprintf / README.md

README.md

Import template
timfa Tim · pushed by timfa · 4 years ago
c788ad20 History
README.md 1.3 KiB Download Raw

extsprintf: extended POSIX-style sprintf

Stripped down version of s[n]printf(3c). We make a best effort to throw an exception when given a format string we don't understand, rather than ignoring it, so that we won't break existing programs if/when we go implement the rest of this.

This implementation currently supports specifying

  • field alignment ('-' flag),
  • zero-pad ('0' flag)
  • always show numeric sign ('+' flag),
  • field width
  • conversions for strings, decimal integers, and floats (numbers).
  • argument size specifiers. These are all accepted but ignored, since

Javascript has no notion of the physical size of an argument.

Everything else is currently unsupported, most notably: precision, unsigned numbers, non-decimal numbers, and characters.

Besides the usual POSIX conversions, this implementation supports:

  • %j: pretty-print a JSON object (using node's "inspect")
  • %r: pretty-print an Error object

Example

First, install it:

npm install extsprintf

Now, use it:

var mod_extsprintf = require('extsprintf'); console.log(mod_extsprintf.sprintf('hello %25s', 'world'));

outputs:

hello world

Also supported

printf: same args as sprintf, but prints the result to stdout

fprintf: same args as sprintf, preceded by a Node stream. Prints the result to the given stream.

Source
1# extsprintf: extended POSIX-style sprintf
2
3Stripped down version of s[n]printf(3c). We make a best effort to throw an
4exception when given a format string we don't understand, rather than ignoring
5it, so that we won't break existing programs if/when we go implement the rest
6of this.
7
8This implementation currently supports specifying
9
10* field alignment ('-' flag),
11* zero-pad ('0' flag)
12* always show numeric sign ('+' flag),
13* field width
14* conversions for strings, decimal integers, and floats (numbers).
15* argument size specifiers. These are all accepted but ignored, since
16 Javascript has no notion of the physical size of an argument.
17
18Everything else is currently unsupported, most notably: precision, unsigned
19numbers, non-decimal numbers, and characters.
20
21Besides the usual POSIX conversions, this implementation supports:
22
23* `%j`: pretty-print a JSON object (using node's "inspect")
24* `%r`: pretty-print an Error object
25
26# Example
27
28First, install it:
29
30 # npm install extsprintf
31
32Now, use it:
33
34 var mod_extsprintf = require('extsprintf');
35 console.log(mod_extsprintf.sprintf('hello %25s', 'world'));
36
37outputs:
38
39 hello world
40
41# Also supported
42
43**printf**: same args as sprintf, but prints the result to stdout
44
45**fprintf**: same args as sprintf, preceded by a Node stream. Prints the result
46to the given stream.