1.8 KiB
terminal-link 
Create clickable links in the terminal
Install
$ npm install terminal-link
Usage
const terminalLink = require('terminal-link');
const link = terminalLink('My Website', 'https://sindresorhus.com');
console.log(link);
API
terminalLink(text, url, options?)
Create a link for use in stdout.
For unsupported terminals, the link will be printed in parens after the text: My website (https://sindresorhus.com).
text
Type: string
Text to linkify.
url
Type: string
URL to link to.
options
Type: object
fallback
Type: Function | boolean
Override the default fallback. The function receives the text and url as parameters and is expected to return a string.
If set to false, the fallback will be disabled when a terminal is unsupported.
terminalLink.isSupported
Type: boolean
Check whether the terminal's stdout supports links.
Prefer just using the default fallback or the fallback option whenever possible.
terminalLink.stderr(text, url, options?)
Create a link for use in stdout.
Same arguments as terminalLink().
terminalLink.stderr.isSupported
Type: boolean
Check whether the terminal's stderr supports links.
Prefer just using the default fallback or the fallback option whenever possible.
Related
- terminal-link-cli - CLI for this module
- ink-link - Link component for Ink
- chalk - Terminal string styling done right