Nominally Patriotic Meathead
    Have ideas to improve npm?Join in the discussion! »

    terminal-link
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    terminal-link

    Create clickable links in the terminal

    Install

    $ npm install terminal-link
    

    Usage

    import terminalLink from '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

    Install

    npm i terminal-link

    DownloadsWeekly Downloads

    8,031,186

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    6.31 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar