aboutsummaryrefslogtreecommitdiff
path: root/node_modules/pupa/index.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/pupa/index.d.ts')
-rw-r--r--node_modules/pupa/index.d.ts32
1 files changed, 32 insertions, 0 deletions
diff --git a/node_modules/pupa/index.d.ts b/node_modules/pupa/index.d.ts
new file mode 100644
index 0000000..762aae0
--- /dev/null
+++ b/node_modules/pupa/index.d.ts
@@ -0,0 +1,32 @@
+/**
+Simple micro templating.
+
+@param template - Text with placeholders for `data` properties.
+@param data - Data to interpolate into `template`.
+
+@example
+```
+import 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;'
+```
+*/
+declare function pupa(
+ template: string,
+ data: unknown[] | {[key: string]: any}
+): string;
+
+export = pupa;