login/node_modules/terminal-link/readme.md
Amruta Kawade 45b10ffd19
Adding node_modules for dependabot (#67)
* Bump lodash from 4.17.15 to 4.17.19 (#52)

Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.15...4.17.19)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Amruta Kawade <65217380+AmrutaKawade@users.noreply.github.com>

* Bump @actions/core from 1.1.3 to 1.2.6 (#60)

Bumps [@actions/core](https://github.com/actions/toolkit/tree/HEAD/packages/core) from 1.1.3 to 1.2.6.
- [Release notes](https://github.com/actions/toolkit/releases)
- [Changelog](https://github.com/actions/toolkit/blob/main/packages/core/RELEASES.md)
- [Commits](https://github.com/actions/toolkit/commits/HEAD/packages/core)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Amruta Kawade <65217380+AmrutaKawade@users.noreply.github.com>

* updating node_nodules

* updated package-lock

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2020-10-12 14:58:40 +05:30

82 lines
1.8 KiB
Markdown

# 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