www.aleph1.co.uk Git - yaffs-website/blob - node_modules/indent-string/readme.md

   1 # indent-string [![Build Status](https://travis-ci.org/sindresorhus/indent-string.svg?branch=master)](https://travis-ci.org/sindresorhus/indent-string)
   2
   3 > Indent each line in a string
   4
   5
   6 ## Install
   7
   8 ```
   9 $ npm install --save indent-string
  10 ```
  11
  12
  13 ## Usage
  14
  15 ```js
  16 var indentString = require('indent-string');
  17
  18 indentString('Unicorns\nRainbows', '♥', 4);
  19 //=> ♥♥♥♥Unicorns
  20 //=> ♥♥♥♥Rainbows
  21 ```
  22
  23
  24 ## API
  25
  26 ### indentString(string, indent, count)
  27
  28 #### string
  29
  30 **Required**
  31 Type: `string`
  32
  33 The string you want to indent.
  34
  35 #### indent
  36
  37 **Required**
  38 Type: `string`
  39
  40 The string to use for the indent.
  41
  42 #### count
  43
  44 Type: `number`
  45 Default: `1`
  46
  47 How many times you want `indent` repeated.
  48
  49
  50 ## Related
  51
  52 - [indent-string-cli](https://github.com/sindresorhus/indent-string-cli) - CLI for this module
  53 - [strip-indent](https://github.com/sindresorhus/strip-indent) - Strip leading whitespace from every line in a string
  54
  55
  56 ## License
  57
  58 MIT © [Sindre Sorhus](http://sindresorhus.com)