diff options
Diffstat (limited to 'node_modules/terminal-link/readme.md')
-rw-r--r-- | node_modules/terminal-link/readme.md | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/node_modules/terminal-link/readme.md b/node_modules/terminal-link/readme.md new file mode 100644 index 0000000..918b1ee --- /dev/null +++ b/node_modules/terminal-link/readme.md @@ -0,0 +1,82 @@ +# terminal-link [![Build Status](https://travis-ci.org/sindresorhus/terminal-link.svg?branch=master)](https://travis-ci.org/sindresorhus/terminal-link) + +> Create clickable links in the terminal + +<img src="screenshot.gif" width="301" height="148"> + +## Install + +``` +$ npm install terminal-link +``` + +## Usage + +```js +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.](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda) + +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](https://github.com/sindresorhus/terminal-link-cli) - CLI for this module +- [ink-link](https://github.com/sindresorhus/ink-link) - Link component for Ink +- [chalk](https://github.com/chalk/chalk) - Terminal string styling done right |