sindresorhus/open


Open stuff like URLs, files, executables. Cross-platform.

License: MIT

Language: JavaScript


open

Open stuff like URLs, files, executables. Cross-platform.

If need this for Electron, use shell.openItem() instead.

Note: The original open package was recently deprecated in favor of this package, and we got the name, so this package is now named open instead of opn. If you're upgrading from the original open package (open@0.0.5 or lower), keep in mind that the API is different.

Why?

  • Actively maintained.
  • Supports app arguments.
  • Safer as it uses spawn instead of exec.
  • Fixes most of the open original node-open issues.
  • Includes the latest xdg-open script for Linux.
  • Supports WSL paths to Windows apps under /mnt/*.

Install

$ npm install open

Usage

const open = require('open');

// Opens the image in the default image viewer
(async () => {
	await open('unicorn.png', {wait: true});
	console.log('The image viewer app closed');

	// Opens the url in the default browser
	await open('https://sindresorhus.com');

	// Specify the app to open in
	await open('https://sindresorhus.com', {app: 'firefox'});

	// Specify app arguments
	await open('https://sindresorhus.com', {app: ['google chrome', '--incognito']});
})();

API

It uses the command open on macOS, start on Windows and xdg-open on other platforms.

open(target, [options])

Returns a promise for the spawned child process. You would normally not need to use this for anything, but it can be useful if you'd like to attach custom event listeners or perform other operations directly on the spawned process.

target

Type: string

The thing you want to open. Can be a URL, file, or executable.

Opens in the default app for the file type. For example, URLs opens in your default browser.

options

Type: object

wait

Type: boolean
Default: false

Wait for the opened app to exit before fulfilling the promise. If false it's fulfilled immediately when opening the app.

Note that it waits for the app to exit, not just for the window to close.

On Windows, you have to explicitly specify an app for it to be able to wait.

background (macOS only)

Type: boolean
Default: false

Do not bring the app to the foreground.

app

Type: string | string[]

Specify the app to open the target with, or an array with the app and app arguments.

The app name is platform dependent. Don't hard code it in reusable modules. For example, Chrome is google chrome on macOS, google-chrome on Linux and chrome on Windows.

You may also pass in the app's full path. For example on WSL, this can be /mnt/c/Program Files (x86)/Google/Chrome/Application/chrome.exe for the Windows installation of Chrome.

Related

  • opn-cli - CLI for this module
  • open-editor - Open files in your editor at a specific line and column

License

MIT © Sindre Sorhus

Project Statistics

Sourcerank 20
Repository Size 70.3 KB
Stars 1,534
Forks 81
Watchers 27
Open issues 22
Dependencies 5
Contributors 20
Tags 25
Created
Last updated
Last pushed

Top Contributors See all

Sindre Sorhus Thomas Watson Arthur Verschaeve Zach Bruggeman Sam Verschueren Stanislav Sysoev Bogdan Chadkin Corey Farrell Justin Niessner Sun Knudsen Paarth Marcello Urbani Deron Dantzler Eric Mandel Gabriel Aumala Stephen Zhao Jente Van Heuverswyn R. Gurung Dimitri Benin Damian Kaczmarek

Packages Referencing this Repo

@brainsights/opn
A better node-open. Opens stuff like websites, files, executables. Cross-platform.
Latest release 5.4.0 - Published - 1.53K stars
opn
Open stuff like URLs, files, executables. Cross-platform.
Latest release 6.0.0 - Updated - 1.53K stars
open
Open stuff like URLs, files, executables. Cross-platform.
Latest release 6.3.0 - Updated - 1.53K stars
opn-2
A better node-open. Opens stuff like websites, files, executables. Cross-platform.
Latest release 5.1.0 - Published - 1.53K stars
org.webjars.npm:opn
WebJar for opn
Latest release 5.2.0 - Updated - 1.53K stars
gix-opn
GIX - A better node-open. Opens stuff like websites, files, executables. Cross-platform.
Latest release 5.4.3 - Updated - 1.53K stars
org.webjars.bowergithub.sindresorhus:opn
WebJar for opn
Latest release 4.0.2 - Published - 1.53K stars
opn
WebJar for opn
Latest release 4.0.2 - Published - 1.53K stars

Recent Tags See all

v6.3.0 May 12, 2019
v6.2.0 April 23, 2019
v6.1.0 April 07, 2019
v6.0.0 March 26, 2019
v5.5.0 March 16, 2019
v5.4.0 September 20, 2018
v5.3.0 March 14, 2018
v5.2.0 January 14, 2018
v5.1.0 June 10, 2017
v5.0.0 April 30, 2017
v4.0.2 May 17, 2016
v4.0.1 March 03, 2016
v4.0.0 January 16, 2016
v3.0.3 November 04, 2015
3.0.2 June 29, 2015

Something wrong with this page? Make a suggestion

Last synced: 2019-05-12 08:52:05 UTC

Login to resync this repository