File: index.d.ts

package info (click to toggle)
node-prepend-http 3.0.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 128 kB
  • sloc: javascript: 59; makefile: 2
file content (33 lines) | stat: -rw-r--r-- 663 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
27
28
29
30
31
32
33
declare namespace prependHttp {
	interface Options {
		/**
		Prepend `https://` instead of `http://`.

		@default true
		*/
		readonly https?: boolean;
	}
}

/**
Prepend `https://` to humanized URLs like `sindresorhus.com` and `localhost`.

@param url - URL to prepend `https://` to.

@example
```
import prependHttp = require('prepend-http');

prependHttp('sindresorhus.com');
//=> 'https://sindresorhus.com'

prependHttp('localhost', {https: false});
//=> 'http://localhost'

prependHttp('https://sindresorhus.com');
//=> 'https://sindresorhus.com'
```
*/
declare function prependHttp(url: string, options?: prependHttp.Options): string;

export = prependHttp;