Home Verkennen Help
Registreren Inloggen
root
/
gs_nuxt
1
0
Vork 0
Bestanden Issues 0 Pull-aanvragen 0 Wiki
Boom: df287f0e0c
Aftakkingen Labels
gs_nuxt
/
node_modules
/
terminal-link
peach a19a732be8 commit message 2 jaren geleden
..
index.d.ts a19a732be8 commit message 2 jaren geleden
index.js a19a732be8 commit message 2 jaren geleden
license a19a732be8 commit message 2 jaren geleden
package.json a19a732be8 commit message 2 jaren geleden
readme.md a19a732be8 commit message 2 jaren geleden

readme.md

terminal-link Build Status

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

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