diff options
Diffstat (limited to 'node_modules/pupa/readme.md')
| -rw-r--r-- | node_modules/pupa/readme.md | 63 |
1 files changed, 0 insertions, 63 deletions
diff --git a/node_modules/pupa/readme.md b/node_modules/pupa/readme.md deleted file mode 100644 index bb9ab18..0000000 --- a/node_modules/pupa/readme.md +++ /dev/null @@ -1,63 +0,0 @@ -# pupa [](https://travis-ci.org/sindresorhus/pupa) - -> Simple micro templating - -Useful when all you need is to fill in some placeholders. - - -## Install - -``` -$ npm install pupa -``` - - -## Usage - -```js -const pupa = require('pupa'); - -pupa('The mobile number of {name} is {phone.mobile}', { - name: 'Sindre', - phone: { - mobile: '609 24 363' - } -}); -//=> 'The mobile number of Sindre is 609 24 363' - -pupa('I like {0} and {1}', ['🦄', '🐮']); -//=> 'I like 🦄 and 🐮' - -// Double braces encodes the HTML entities to avoid code injection -pupa('I like {{0}} and {{1}}', ['<br>🦄</br>', '<i>🐮</i>']); -//=> 'I like <br>🦄</br> and <i>🐮</i>' -``` - - -## API - -### pupa(template, data) - -#### template - -Type: `string` - -Text with placeholders for `data` properties. - -#### data - -Type: `object | unknown[]` - -Data to interpolate into `template`. - - -## FAQ - -### What about template literals? - -Template literals expand on creation. This module expands the template on execution, which can be useful if either or both template and data are lazily created or user-supplied. - - -## Related - -- [pupa-cli](https://github.com/sindresorhus/pupa-cli) - CLI for this module |