strip-indent

  • Version 4.1.0
  • Published
  • 4.74 kB
  • No dependencies
  • MIT license

Install

npm i strip-indent
yarn add strip-indent
pnpm add strip-indent

Overview

Strip leading whitespace from each line in a string

Index

Functions

function dedent

dedent: (string: string) => string;
  • Strip leading whitespace from each line in a string and remove surrounding blank lines.

    The line with the least number of leading whitespace, ignoring empty lines, determines the number to remove. Leading and trailing lines that contain only whitespace are removed.

    Useful for template literals and multi-line strings where you want clean boundaries.

    Example 1

    import {dedent} from 'strip-indent';
    dedent(`
    unicorn
    cake
    `);
    //unicorn
    // cake

function stripIndent

stripIndent: (string: string) => string;
  • Strip leading whitespace from each line in a string.

    The line with the least number of leading whitespace, ignoring empty lines, determines the number to remove.

    Example 1

    import stripIndent from 'strip-indent';
    const string = '\tunicorn\n\t\tcake';
    // unicorn
    // cake
    stripIndent(string);
    //unicorn
    // cake

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (2)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/strip-indent.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/strip-indent)
  • HTML
    <a href="https://www.jsdocs.io/package/strip-indent"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>