terminal-link
Create clickable links in the terminal
Last updated 3 months ago by sindresorhus .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install terminal-link 
SYNC missed versions from official npm registry.

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

Override the default fallback. The function receives the text and url as parameters and is expected to return a string.

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

Current Tags

  • 2.0.0                                ...           latest (3 months ago)

5 Versions

  • 2.0.0                                ...           3 months ago
  • 1.3.0                                ...           7 months ago
  • 1.2.0                                ...           a year ago
  • 1.1.0                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
Maintainers (1)
Downloads
Today 420
This Week 420
This Month 16,235
Last Day 356
Last Week 6,752
Last Month 26,217
Dependencies (2)
Dev Dependencies (4)
Dependents (189)

Copyright 2014 - 2017 © taobao.org |