aboutsummaryrefslogtreecommitdiff
path: root/node_modules/pupa/readme.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2022-06-04 08:51:01 +0200
committerMinteck <contact@minteck.org>2022-06-04 08:51:01 +0200
commit383285ecd5292bf9a825e05904955b937de84cc9 (patch)
tree0a53b6f02c1604b078044567c03dc1b6c944c8c2 /node_modules/pupa/readme.md
downloadequestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.gz
equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.bz2
equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.zip
Initial commit
Diffstat (limited to 'node_modules/pupa/readme.md')
-rw-r--r--node_modules/pupa/readme.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/node_modules/pupa/readme.md b/node_modules/pupa/readme.md
new file mode 100644
index 0000000..bb9ab18
--- /dev/null
+++ b/node_modules/pupa/readme.md
@@ -0,0 +1,63 @@
+# pupa [![Build Status](https://travis-ci.org/sindresorhus/pupa.svg?branch=master)](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 &lt;br&gt;🦄&lt;/br&gt; and &lt;i&gt;🐮&lt;/i&gt;'
+```
+
+
+## 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