Split a String into a List of Lines in JavaScript or Node.js

JavaScript provides a handful of foundational string methods in the stdlib. You can use the given methods to compose your own utility functions. For example, you can split a multiline string into an array of lines. Each line in that array is a string as well. From here, you can format, transform or change the individual lines to your needs.

This tutorial shows you how to split a string on line breaks into a list of strings representing the individual lines.

Node.js Series Overview

  1. String Replace All Appearances
  2. Remove All Whitespace From a String in JavaScript
  3. Generate a Random ID or String in Node.js or JavaScript
  4. Remove Extra Spaces From a String in JavaScript or Node.js
  5. Remove Numbers From a String in JavaScript or Node.js
  6. Get the Part Before a Character in a String in JavaScript or Node.js
  7. Get the Part After a Character in a String in JavaScript or Node.js
  8. How to Check if a Value is a String in JavaScript or Node.js
  9. Check If a String Includes All Strings in JavaScript/Node.js/TypeScript
  10. Check if a Value is a String in JavaScript and Node.js
  11. Limit and Truncate a String to a Given Length in JavaScript and Node.js
  12. Split a String into a List of Characters in JavaScript and Node.js
  13. How to Generage a UUID in Node.js
  14. Reverse a String in JavaScript or Node.js
  15. Split a String into a List of Lines in JavaScript or Node.js
  16. Split a String into a List of Words in JavaScript or Node.js
  17. Detect if a String is in camelCase Format in Javascript or Node.js
  18. Check If a String Is in Lowercase in JavaScript or Node.js
  19. Check If a String is in Uppercase in JavaScript or Node.js
  20. Get the Part After First Occurrence in a String in JavaScript or Node.js
  21. Get the Part Before First Occurrence in a String in JavaScript or Node.js
  22. Get the Part Before Last Occurrence in a String in JavaScript or Node.js
  23. Get the Part After Last Occurrence in a String in JavaScript or Node.js
  24. How to Count Words in a File
  25. How to Shuffle the Characters of a String in JavaScript or Node.js
  26. Append Characters or Words to a String in JavaScript or Node.js
  27. Check if a String is Empty in JavaScript or Node.js
  28. Ensure a String Ends with a Given Character in JavaScript or Node.js
  29. Left-Trim Characters Off a String in JavaScript or Node.js
  30. Right-Trim Characters Off a String in JavaScript or Node.js
  31. Lowercase the First Character of a String in JavaScript or Node.js
  32. Uppercase the First Character of a String in JavaScript or Node.js
  33. Prepend Characters or Words to a String in JavaScript or Node.js
  34. Check if a String is a Number
  35. Convert a String to Buffer
  36. Prevent Line Breaks in String Template Literals
  37. How to Implement a Custom `toString` Method (Coming soon)
  38. What Is `Symbol.toStringTag` and How to Use It (Coming soon)

Splitting a String on the Newline Character

You can split a long string into its individual lines when seeing a line break. A line break uses the “newline” character. The character to represent a new line in JavaScript is the same as in other languages: \n.

Here’s a utility function splitting a text at the newline character:

/**
 * Returns an array of lines for the given `text`.
 *
 * @param {String} text
 *
 * @returns {String[]}
 */
function lines(text) {  
  return text.split('\n')
}

You may then use the lines utility function like this:

const text = `  
Hey pal,

Supercharge is awesome!  
`

const lines = lines(text)  
// ['', 'Hey pal,', '', 'Supercharge is awesome!']

The template literal in JavaScript is a way to create multiline string values. When wrapping the text to a new line it contains the related line breaks.

Use the @supercharge/strings Package

I’m the maintainer of the @supercharge/strings package providing convenient string utilities. It provides a useful Str#lines() method returning a list of strings representing the individual lines of the given string value:

const Str = require('@supercharge/strings')

const text = `  
Hey pal,

Supercharge is awesome!  
`

Str(text).lines()  
// ['', 'Hey pal,', '', 'Supercharge is awesome!']

Str('').lines()  
// ['']

That’s it!


Mentioned Resources

Explore the Library

Find interesting tutorials and solutions for your problems.