❤
npm
Sign UpSign In

strfmt

0.1.0 • Public • Published

strfmt.js npm Version Build Status Coverage Status

Named string interpolation, with format specifiers.

Usage

var tmpl = '{ date.day : %02d }-{ date.month : %02d }-{ date.year }';
var data = {
  date: {
    day: 25,
    month: 1,
    year: 2015
  }
};
 
strfmt(tmpl)(data); //=> '25-01-2015'
  1. Keys in tmpl are delimited by { and }.
  2. Reference a nested value in data using a dot-delimited string (eg. date.day above).
  3. Optionally state a format specifier for each key after a : character. The %s format specifier is assumed for keys without one.

More usage examples are in the tests.

Note that under the hood, strfmt uses:

API

strfmt(tmpl)(data)

Returns a String, the result of interpolating data into tmpl.

  • tmpl — The template String.
  • data — An Object literal of values.

Installation

Install via npm:

$ npm i --save strfmt

Install via bower:

$ bower i --save yuanqing/strfmt

To use strfmt in the browser, include the minified script in your HTML:

<body>
  <!-- ... -->
  <script src="path/to/dist/strfmt.min.js"></script> 
  <script>
    // strfmt available here
  </script> 
</body>

Changelog

  • 0.1.0
    • Initial release

License

MIT license

Readme

Keywords

Package Sidebar

Install

npm i strfmt

Repository

github.com/yuanqing/strfmt

Homepage

github.com/yuanqing/strfmt

Weekly Downloads

4

Version

0.1.0

License

MIT

Last publish

Collaborators

  • yuanqing
Try on RunKit
Report malware