Blame view

node_modules/indent-string/readme.md 988 Bytes
aaac7fed   liuqimichale   add
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
  # indent-string [![Build Status](https://travis-ci.org/sindresorhus/indent-string.svg?branch=master)](https://travis-ci.org/sindresorhus/indent-string)
  
  > Indent each line in a string
  
  
  ## Install
  
  ```
  $ npm install --save indent-string
  ```
  
  
  ## Usage
  
  ```js
  var indentString = require('indent-string');
  
  indentString('Unicorns\nRainbows', '♥', 4);
  //=> ♥♥♥♥Unicorns
  //=> ♥♥♥♥Rainbows
  ```
  
  
  ## API
  
  ### indentString(string, indent, count)
  
  #### string
  
  **Required**  
  Type: `string`
  
  The string you want to indent.
  
  #### indent
  
  **Required**  
  Type: `string`
  
  The string to use for the indent.
  
  #### count
  
  Type: `number`  
  Default: `1`
  
  How many times you want `indent` repeated.
  
  
  ## 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](http://sindresorhus.com)