travel/admin/node_modules/indent-string/readme.md

1.2 KiB

indent-string Build Status

Indent each line in a string

Install

$ npm install indent-string

Usage

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
Default: 1

How many times you want indent repeated.

options

Type: Object

indent

Type: string
Default: ' '

String to use for the indent.

includeEmptyLines

Type: boolean
Default: false

Also indent empty lines.

License

MIT © Sindre Sorhus