blob: 6c2c24e266f6516d42568a4e4f30f14f61ae47c6 (
plain)
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
declare namespace terminalLink {
interface Options {
/**
Override the default fallback. If false, the fallback will be disabled.
@default `${text} (${url})`
*/
fallback?: ((text: string, url: string) => string) | boolean;
}
}
declare const terminalLink: {
/**
Create a clickable link in the terminal's stdout.
[Supported terminals.](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)
For unsupported terminals, the link will be printed in parens after the text: `My website (https://sindresorhus.com)`,
unless the fallback is disabled by setting the `fallback` option to `false`.
@param text - Text to linkify.
@param url - URL to link to.
@example
```
import terminalLink = require('terminal-link');
const link = terminalLink('My Website', 'https://sindresorhus.com');
console.log(link);
```
*/
(text: string, url: string, options?: terminalLink.Options): string;
/**
Check whether the terminal supports links.
Prefer just using the default fallback or the `fallback` option whenever possible.
*/
readonly isSupported: boolean;
readonly stderr: {
/**
Create a clickable link in the terminal's stderr.
[Supported terminals.](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)
For unsupported terminals, the link will be printed in parens after the text: `My website (https://sindresorhus.com)`.
@param text - Text to linkify.
@param url - URL to link to.
@example
```
import terminalLink = require('terminal-link');
const link = terminalLink.stderr('My Website', 'https://sindresorhus.com');
console.error(link);
```
*/
(text: string, url: string, options?: terminalLink.Options): string;
/**
Check whether the terminal's stderr supports links.
Prefer just using the default fallback or the `fallback` option whenever possible.
*/
readonly isSupported: boolean;
}
};
export = terminalLink;
|
