@dozerg/end-of-line

End-of-line

Determine EOL based on given text and OS.

Install

npm i @dozerg/end-of-line

Usage

import { endOfLine } from '@dozerg/end-of-line';

// Detect OS-specific EOL.
const default_eol = endOfLine();

// Detect EOL for a given text.
const text = 'some\ntext\nwith\r\nnewlines\r';
const text_eol = endOfLine(text); // '\n'

// Detect EOL for a file.
const filename = '/path/to/file.ext';
const file_eol = endOfLineForFile(filename);

APIs

function endOfLine(): string

Determine the OS-specific end-of-line marker. Equivalent to os.EOL.

function endOfLine(text: string): string

Determine end-of-line marker for a given text. The following markers will be recognized:

• \n
• \r\n
• \r
• \n\r

If there is no EOL found, os.EOL will be returned.

function endOfLineForFile(filePath: string): string

Determine end-of-line marker for a given file.

If file doesn't exist or cannot be read, os.EOL will be returned.

License

MIT