diff options
| author | ruki <waruqi@gmail.com> | 2018-11-08 00:38:48 +0800 |
|---|---|---|
| committer | ruki <waruqi@gmail.com> | 2018-11-07 21:53:09 +0800 |
| commit | 26105034da4fcce7ac883c899d781f016559310d (patch) | |
| tree | c459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/indent-string/readme.md | |
| parent | 2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff) | |
| download | xmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip | |
switch to vuepress
Diffstat (limited to 'node_modules/indent-string/readme.md')
| -rw-r--r-- | node_modules/indent-string/readme.md | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/node_modules/indent-string/readme.md b/node_modules/indent-string/readme.md new file mode 100644 index 00000000..d2592d73 --- /dev/null +++ b/node_modules/indent-string/readme.md @@ -0,0 +1,72 @@ +# indent-string [](https://travis-ci.org/sindresorhus/indent-string) + +> Indent each line in a string + + +## Install + +``` +$ npm install indent-string +``` + + +## Usage + +```js +const indentString = require('indent-string'); + +indentString('Unicorns\nRainbows', 4); +//=> ' Unicorns' +//=> ' Rainbows' + +indentString('Unicorns\nRainbows', 4, {indent: '♥'}); +//=> '♥♥♥♥Unicorns' +//=> '♥♥♥♥Rainbows' +``` + + +## API + +### indentString(input, [count], [options]) + +#### input + +Type: `string` + +String you want to indent. + +#### count + +Type: `number`<br> +Default: `1` + +How many times you want `indent` repeated. + +#### 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 + +- [indent-string-cli](https://github.com/sindresorhus/indent-string-cli) - CLI for this module +- [strip-indent](https://github.com/sindresorhus/strip-indent) - Strip leading whitespace from every line in a string + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |
