[TypeScript'ed copy of sindresorhus/opn] A better node-open. Opens stuff like websites, files, executables. Cross-platform.
npm install @toba/open
!Code style
opn:
spawn instead of exec
node-open issues
xdg-open script for Linux
bash
$ yarn add '@toba/open'
`
Usage
`ts
import open = from '@toba/open';
// Opens the image in the default image viewer
open('unicorn.png').then(() => {
// image viewer closed
});
// Opens the url in the default browser
open('http://trailimage.com');
// Specify the app to open in
open('http://trailimage.com', {app: 'firefox'});
// Specify app arguments
open('http://trailimage.com', {app: ['google chrome', '--incognito']});
`
API
Uses the command open on macOS, start on Windows and xdg-open on other platforms.
$3
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:
Wait for the opened app to exit before fulfilling the promise. If false it's fulfilled immediately when opening the app.
On Windows you have to explicitly specify an app for it to be able to wait.
##### app
Type: string Array
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.