index.d.ts 614 Bytes
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
declare const detectNewline: {
	/**
	Detect the dominant newline character of a string.

	@returns The detected newline or `undefined` when no newline character is found.

	@example
	```
	import detectNewline = require('detect-newline');

	detectNewline('foo\nbar\nbaz\r\n');
	//=> '\n'
	```
	*/
	(string: string): '\r\n' | '\n' | undefined;

	/**
	Detect the dominant newline character of a string.

	@returns The detected newline or `\n` when no newline character is found or the input is not a string.
	*/
	graceful(string: string): '\r\n' | '\n';
	graceful(string?: unknown): '\n';
};

export = detectNewline;