History

github-actions[bot] 7ad2aa66bb Add node modules and new code for release (#39 ) Co-authored-by: tbarnes94 <tbarnes94@users.noreply.github.com>		2022-01-05 11:26:06 -05:00
..
index.d.ts	Add node modules and new code for release (#39 )	2022-01-05 11:26:06 -05:00
index.js	Add node modules and new code for release (#39 )	2022-01-05 11:26:06 -05:00
license	Add node modules and new code for release (#39 )	2022-01-05 11:26:06 -05:00
package.json	Add node modules and new code for release (#39 )	2022-01-05 11:26:06 -05:00
readme.md	Add node modules and new code for release (#39 )	2022-01-05 11:26:06 -05:00

readme.md

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.

Supported terminals.

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?)