diff options
Diffstat (limited to 'node_modules/indent-string/readme.md')
| -rw-r--r-- | node_modules/indent-string/readme.md | 37 |
1 files changed, 20 insertions, 17 deletions
diff --git a/node_modules/indent-string/readme.md b/node_modules/indent-string/readme.md index 89f14acd4..bc4745600 100644 --- a/node_modules/indent-string/readme.md +++ b/node_modules/indent-string/readme.md @@ -13,39 +13,42 @@ $ npm install --save indent-string ## Usage ```js -var indentString = require('indent-string'); +const indentString = require('indent-string'); -indentString('Unicorns\nRainbows', '♥', 4); -//=> ♥♥♥♥Unicorns -//=> ♥♥♥♥Rainbows +indentString('Unicorns\nRainbows', 4); +//=> ' Unicorns' +//=> ' Rainbows' + +indentString('Unicorns\nRainbows', 4, '♥'); +//=> '♥♥♥♥Unicorns' +//=> '♥♥♥♥Rainbows' ``` ## API -### indentString(string, indent, count) - -#### string - -**Required** -Type: `string` - -The string you want to indent. +### indentString(input, [count], [indent]) -#### indent +#### input -**Required** Type: `string` -The string to use for the indent. +String you want to indent. #### count -Type: `number` +Type: `number`<br> Default: `1` How many times you want `indent` repeated. +#### indent + +Type: `string`<br> +Default: `' '` + +String to use for the indent. + ## Related @@ -55,4 +58,4 @@ How many times you want `indent` repeated. ## License -MIT © [Sindre Sorhus](http://sindresorhus.com) +MIT © [Sindre Sorhus](https://sindresorhus.com) |