summaryrefslogtreecommitdiffstats
path: root/node_modules/indent-string/index.d.ts
diff options
context:
space:
mode:
authorGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
committerGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
commite06ec920f7a5d784e674c4c4b4e6d1da3dc7391d (patch)
tree55713f725f77b44ebfec86e4eec3ce33e71458ca /node_modules/indent-string/index.d.ts
downloadwebsite_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.gz
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.bz2
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.zip
api, login, auth
Diffstat (limited to 'node_modules/indent-string/index.d.ts')
-rw-r--r--node_modules/indent-string/index.d.ts42
1 files changed, 42 insertions, 0 deletions
diff --git a/node_modules/indent-string/index.d.ts b/node_modules/indent-string/index.d.ts
new file mode 100644
index 0000000..1185231
--- /dev/null
+++ b/node_modules/indent-string/index.d.ts
@@ -0,0 +1,42 @@
+declare namespace indentString {
+ interface Options {
+ /**
+ The string to use for the indent.
+
+ @default ' '
+ */
+ readonly indent?: string;
+
+ /**
+ Also indent empty lines.
+
+ @default false
+ */
+ readonly includeEmptyLines?: boolean;
+ }
+}
+
+/**
+Indent each line in a string.
+
+@param string - The string to indent.
+@param count - How many times you want `options.indent` repeated. Default: `1`.
+
+@example
+```
+import indentString = require('indent-string');
+
+indentString('Unicorns\nRainbows', 4);
+//=> ' Unicorns\n Rainbows'
+
+indentString('Unicorns\nRainbows', 4, {indent: '♥'});
+//=> '♥♥♥♥Unicorns\n♥♥♥♥Rainbows'
+```
+*/
+declare function indentString(
+ string: string,
+ count?: number,
+ options?: indentString.Options
+): string;
+
+export = indentString;