/eol

JavaScript newline character converter

Primary LanguageHTMLMIT LicenseMIT

eol

Newline character converter for JavaScript. Available on npm.

npm install eol --save

require or import

const eol = require("eol")
import eol from "eol"

API

eol.auto(text)

  • Normalize line endings in text to match the current operating system
  • Returns string with line endings normalized to \r\n or \n

eol.crlf(text)

  • Normalize line endings in text to CRLF (Windows, DOS)
  • Returns string with line endings normalized to \r\n

eol.lf(text)

  • Normalize line endings in text to LF (Unix, OS X)
  • Returns string with line endings normalized to \n

eol.cr(text)

  • Normalize line endings in text to CR (Mac OS)
  • Returns string with line endings normalized to \r

eol.dub(text)

eol.before(text)

  • Add linebreak before text
  • Returns string with linebreak added before text

eol.after(text)

  • Add linebreak after text
  • Returns string with linebreak added after text

eol.match(text)

  • Detect or inspect linebreaks in text
  • Returns array of matched linebreaks

eol.split(text)

  • Split text by newline
  • Returns array of lines

Joining

Coercing eol.auto|eol.crlf|eol.lf|eol.cr to string yields the appropriate character. This is useful for joining.

String(eol.lf) // "\n"
eol.split(text).join(eol.auto) // same as eol.auto(text)
eol.split(text).filter(line => line).join(eol.auto) // text joined after removing empty lines
eol.split(text).slice(-3).join(eol.auto) // last 3 lines joined

Matching

Detect or inspect via match

eol.match(" ") // []
eol.match("world\nwide\nweb") // ["\n","\n"]

Dubbing

Mixin friendly

let lflf = eol.dub("\n\n")
lflf("...")

got space?

opensource

MIT License