Blame view

node_modules/extsprintf/README.md 1.33 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
  # 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.