Skip to content

limitBlankLines

Import from @varavel/vdl-plugin-sdk/utils/strings.

function limitBlankLines(str, maxConsecutive?): string;

Limits the number of consecutive blank lines in a string.

Parameters

Parameter Type Default value Description
str string undefined The string to process.
maxConsecutive number 0 The maximum number of consecutive blank lines allowed. Defaults to 0 (no blank lines allowed).

Returns

string

The string with consecutive blank lines limited.

Examples

limitBlankLines("a\n\n\nb", 2)
// "a\n\n\nb"
limitBlankLines("a\n\n\n\nb", 2)
// "a\n\n\nb"
limitBlankLines("a\n\n\nb", 1)
// "a\n\nb"
limitBlankLines("a\n\n\nb", 0)
// "a\nb"