blob: 49967de074f2fd109cdb550a468e83ed579a668b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
# 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\n Rainbows'
indentString('Unicorns\nRainbows', 4, {indent: '♥'});
//=> '♥♥♥♥Unicorns\n♥♥♥♥Rainbows'
```
## API
### indentString(string, [count], [options])
#### string
Type: `string`
The string to indent.
#### count
Type: `number`<br>
Default: `1`
How many times you want `options.indent` repeated.
#### options
Type: `object`
##### indent
Type: `string`<br>
Default: `' '`
The 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)
|
