File: index.d.ts

package info (click to toggle)
node-detect-newline 3.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 128 kB
  • sloc: javascript: 55; makefile: 2
file content (26 lines) | stat: -rw-r--r-- 614 bytes parent folder | download | duplicates (2)
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;