FM / indent-string

/var/www/flurhymez/node_modules/indent-string/

/var/www/flurhymez/node_modules/indent-string

Name	Size	Mode	Actions
index.d.ts	783	0644	edit dl rm
index.js	743	0644	edit dl rm
license	1109	0644	edit dl rm
package.json	1647	0644	edit dl rm
readme.md	1181	0644	edit dl rm

Edit: /var/www/flurhymez/node_modules/indent-string/readme.md (1181B)

# 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 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

cmd: