indent-string
TypeScript icon, indicating that this package has built-in type declarations

5.0.0 • Public • Published

indent-string

Indent each line in a string

Install

$ npm install indent-string

Usage

import indentString from '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


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Dependencies (0)

    Dev Dependencies (3)

    Package Sidebar

    Install

    npm i indent-string

    Weekly Downloads

    40,339,460

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    4.74 kB

    Total Files

    5

    Last publish

    Collaborators

    • sindresorhus