www.aleph1.co.uk Git - yaffs-website/blob - node_modules/sprintf-js/README.md

   1 # sprintf.js
   2 **sprintf.js** is a complete open source JavaScript sprintf implementation for the *browser* and *node.js*.
   3
   4 Its prototype is simple:
   5
   6     string sprintf(string format , [mixed arg1 [, mixed arg2 [ ,...]]])
   7
   8 The placeholders in the format string are marked by `%` and are followed by one or more of these elements, in this order:
   9
  10 * An optional number followed by a `$` sign that selects which argument index to use for the value. If not specified, arguments will be placed in the same order as the placeholders in the input string.
  11 * An optional `+` sign that forces to preceed the result with a plus or minus sign on numeric values. By default, only the `-` sign is used on negative numbers.
  12 * An optional padding specifier that says what character to use for padding (if specified). Possible values are `0` or any other character precedeed by a `'` (single quote). The default is to pad with *spaces*.
  13 * An optional `-` sign, that causes sprintf to left-align the result of this placeholder. The default is to right-align the result.
  14 * An optional number, that says how many characters the result should have. If the value to be returned is shorter than this number, the result will be padded. When used with the `j` (JSON) type specifier, the padding length specifies the tab size used for indentation.
  15 * An optional precision modifier, consisting of a `.` (dot) followed by a number, that says how many digits should be displayed for floating point numbers. When used with the `g` type specifier, it specifies the number of significant digits. When used on a string, it causes the result to be truncated.
  16 * A type specifier that can be any of:
  17     * `%` — yields a literal `%` character
  18     * `b` — yields an integer as a binary number
  19     * `c` — yields an integer as the character with that ASCII value
  20     * `d` or `i` — yields an integer as a signed decimal number
  21     * `e` — yields a float using scientific notation
  22     * `u` — yields an integer as an unsigned decimal number
  23     * `f` — yields a float as is; see notes on precision above
  24     * `g` — yields a float as is; see notes on precision above
  25     * `o` — yields an integer as an octal number
  26     * `s` — yields a string as is
  27     * `x` — yields an integer as a hexadecimal number (lower-case)
  28     * `X` — yields an integer as a hexadecimal number (upper-case)
  29     * `j` — yields a JavaScript object or array as a JSON encoded string
  30
  31 ## JavaScript `vsprintf`
  32 `vsprintf` is the same as `sprintf` except that it accepts an array of arguments, rather than a variable number of arguments:
  33
  34     vsprintf("The first 4 letters of the english alphabet are: %s, %s, %s and %s", ["a", "b", "c", "d"])
  35
  36 ## Argument swapping
  37 You can also swap the arguments. That is, the order of the placeholders doesn't have to match the order of the arguments. You can do that by simply indicating in the format string which arguments the placeholders refer to:
  38
  39     sprintf("%2$s %3$s a %1$s", "cracker", "Polly", "wants")
  40 And, of course, you can repeat the placeholders without having to increase the number of arguments.
  41
  42 ## Named arguments
  43 Format strings may contain replacement fields rather than positional placeholders. Instead of referring to a certain argument, you can now refer to a certain key within an object. Replacement fields are surrounded by rounded parentheses - `(` and `)` - and begin with a keyword that refers to a key:
  44
  45     var user = {
  46         name: "Dolly"
  47     }
  48     sprintf("Hello %(name)s", user) // Hello Dolly
  49 Keywords in replacement fields can be optionally followed by any number of keywords or indexes:
  50
  51     var users = [
  52         {name: "Dolly"},
  53         {name: "Molly"},
  54         {name: "Polly"}
  55     ]
  56     sprintf("Hello %(users[0].name)s, %(users[1].name)s and %(users[2].name)s", {users: users}) // Hello Dolly, Molly and Polly
  57 Note: mixing positional and named placeholders is not (yet) supported
  58
  59 ## Computed values
  60 You can pass in a function as a dynamic value and it will be invoked (with no arguments) in order to compute the value on-the-fly.
  61
  62     sprintf("Current timestamp: %d", Date.now) // Current timestamp: 1398005382890
  63     sprintf("Current date and time: %s", function() { return new Date().toString() })
  64
  65 # AngularJS
  66 You can now use `sprintf` and `vsprintf` (also aliased as `fmt` and `vfmt` respectively) in your AngularJS projects. See `demo/`.
  67
  68 # Installation
  69
  70 ## Via Bower
  71
  72     bower install sprintf
  73
  74 ## Or as a node.js module
  75
  76     npm install sprintf-js
  77
  78 ### Usage
  79
  80     var sprintf = require("sprintf-js").sprintf,
  81         vsprintf = require("sprintf-js").vsprintf
  82
  83     sprintf("%2$s %3$s a %1$s", "cracker", "Polly", "wants")
  84     vsprintf("The first 4 letters of the english alphabet are: %s, %s, %s and %s", ["a", "b", "c", "d"])
  85
  86 # License
  87
  88 **sprintf.js** is licensed under the terms of the 3-clause BSD license.