@stdlib/utils-open-url

Open a URL.

Usage no npm install needed!

<script type="module">
  import stdlibUtilsOpenUrl from 'https://cdn.skypack.dev/@stdlib/utils-open-url';
</script>

README

Open URL

NPM version Build Status Coverage Status

Open a URL.

Installation

npm install @stdlib/utils-open-url

Usage

var openURL = require( '@stdlib/utils-open-url' );

openURL( url )

Opens a URL in a user's default browser.

var proc = openURL( 'https://google.com' );

The returned child process is unreferenced, and, thus, the calling process will not wait for the child process to end before exiting. To try and end the child process, send an appropriate kill signal.

var proc = openURL( 'https://google.com' );

function close() {
    proc.kill( 'SIGINT' );
}

setTimeout( close, 1000 );

Web Browser

In a web browser, openURL defers to the window.open() method.

openURL( url )

Opens a URL either in a new tab or window (based on the web browser and/or user preferences), returning a reference to a window object.

var win = openURL( 'https://google.com' );

Examples

var openURL = require( '@stdlib/utils-open-url' );

// Open a URL:
var proc = openURL( 'https://github.com' );

// After some time, kill the spawned process...
function close() {
    proc.kill( 'SIGINT' );
}

setTimeout( close, 5000 );

CLI

Installation

To use the module as a general utility, install the module globally

npm install -g @stdlib/utils-open-url

Usage

Usage: open-url [options] <url>

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ open-url https://github.com
<pid>

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.