time-to-botec/js/node_modules/@stdlib/utils/open-url
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00
..
bin feat: add the node modules 2022-12-03 12:44:49 +00:00
docs feat: add the node modules 2022-12-03 12:44:49 +00:00
etc feat: add the node modules 2022-12-03 12:44:49 +00:00
lib feat: add the node modules 2022-12-03 12:44:49 +00:00
package.json feat: add the node modules 2022-12-03 12:44:49 +00:00
README.md feat: add the node modules 2022-12-03 12:44:49 +00:00

Open URL

Open a 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

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>