aboutsummaryrefslogtreecommitdiff
path: root/node_modules/indent-string/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/indent-string/readme.md')
-rw-r--r--node_modules/indent-string/readme.md19
1 files changed, 15 insertions, 4 deletions
diff --git a/node_modules/indent-string/readme.md b/node_modules/indent-string/readme.md
index bc4745600..d2592d73f 100644
--- a/node_modules/indent-string/readme.md
+++ b/node_modules/indent-string/readme.md
@@ -6,7 +6,7 @@
## Install
```
-$ npm install --save indent-string
+$ npm install indent-string
```
@@ -19,7 +19,7 @@ indentString('Unicorns\nRainbows', 4);
//=> ' Unicorns'
//=> ' Rainbows'
-indentString('Unicorns\nRainbows', 4, '♥');
+indentString('Unicorns\nRainbows', 4, {indent: '♥'});
//=> '♥♥♥♥Unicorns'
//=> '♥♥♥♥Rainbows'
```
@@ -27,7 +27,7 @@ indentString('Unicorns\nRainbows', 4, '♥');
## API
-### indentString(input, [count], [indent])
+### indentString(input, [count], [options])
#### input
@@ -42,13 +42,24 @@ Default: `1`
How many times you want `indent` repeated.
-#### indent
+#### options
+
+Type: `Object`<br>
+
+##### indent
Type: `string`<br>
Default: `' '`
String to use for the indent.
+##### includeEmptyLines
+
+Type: `boolean`<br>
+Default: `false`
+
+Also indent empty lines.
+
## Related