242417d45d | ||
---|---|---|
.. | ||
index.d.ts | ||
index.js | ||
license | ||
package.json | ||
readme.md |
readme.md
indent-string
Indent each line in a string
Install
$ npm install indent-string
Usage
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
Default: 1
How many times you want options.indent
repeated.
options
Type: object
indent
Type: string
Default: ' '
The string to use for the indent.
includeEmptyLines
Type: boolean
Default: false
Also indent empty lines.
Related
- indent-string-cli - CLI for this module
- strip-indent - Strip leading whitespace from every line in a string
License
MIT © Sindre Sorhus