You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
43 lines
1.2 KiB
43 lines
1.2 KiB
# expand-template |
|
|
|
> Expand placeholders in a template string. |
|
|
|
[![npm](https://img.shields.io/npm/v/expand-template.svg)](https://www.npmjs.com/package/expand-template) |
|
[![Build Status](https://travis-ci.org/ralphtheninja/expand-template.svg?branch=master)](https://travis-ci.org/ralphtheninja/expand-template) |
|
[![dependencies](https://david-dm.org/ralptheninja/expand-template.svg)](https://david-dm.org/ralptheninja/expand-template) |
|
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) |
|
|
|
## Install |
|
|
|
``` |
|
$ npm i expand-template -S |
|
``` |
|
|
|
## Usage |
|
|
|
Default functionality expands templates using `{}` as separators for string placeholders. |
|
|
|
```js |
|
var expand = require('expand-template')() |
|
var template = '{foo}/{foo}/{bar}/{bar}' |
|
console.log(expand(template, { |
|
foo: 'BAR', |
|
bar: 'FOO' |
|
})) |
|
// -> BAR/BAR/FOO/FOO |
|
``` |
|
|
|
Custom separators: |
|
|
|
```js |
|
var expand = require('expand-template')({ sep: '[]' }) |
|
var template = '[foo]/[foo]/[bar]/[bar]' |
|
console.log(expand(template, { |
|
foo: 'BAR', |
|
bar: 'FOO' |
|
})) |
|
// -> BAR/BAR/FOO/FOO |
|
``` |
|
|
|
## License |
|
All code, unless stated otherwise, is dual-licensed under [`WTFPL`](http://www.wtfpl.net/txt/copying/) and [`MIT`](https://opensource.org/licenses/MIT).
|
|
|