opn 4.0.2

A better node-open. Opens stuff like websites, files, executables. Cross-platform.

Homepage: https://github.com/sindresorhus/opn#readme

Platform: npm

Language: Shell

License: MIT

Keywords: app, open, opn, opener, opens, launch, start, xdg-open, xdg, default, cmd, browser, editor, executable, exe, url, urls, arguments, args, spawn, exec, child, process, website, file

Repository: git+https://github.com/sindresorhus/opn.git

View on registry: https://www.npmjs.com/package/opn

Direct download link: https://registry.npmjs.org/opn/-/opn-4.0.2.tgz

Install: npm install [email protected]


opn

A better node-open. Opens stuff like websites, files, executables. Cross-platform.

Why?

  • Actively maintained
  • Supports app arguments
  • Safer as it uses spawn instead of exec
  • Fixes most of the open node-open issues
  • Includes the latest xdg-open script for Linux

Install

$ npm install --save opn

Usage

const opn = require('opn');

// Opens the image in the default image viewer
opn('unicorn.png').then(() => {
	// image viewer closed
});

// Opens the url in the default browser
opn('http://sindresorhus.com');

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

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

API

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

opn(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: true

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.

Related

License

MIT © Sindre Sorhus

Releases

4.0.2 May 17, 2016
4.0.1 March 03, 2016
4.0.0 January 16, 2016
3.0.3 November 04, 2015
3.0.2 June 29, 2015
3.0.1 June 29, 2015
3.0.0 June 29, 2015
2.0.1 June 20, 2015
2.0.0 June 13, 2015
1.0.2 April 22, 2015
See all 15 releases

Project Statistics

SourceRank 23
Dependencies 2
Dependent projects 1.49K
Dependent repositories 15K
Total releases 15
Latest release
First release
Stars 496
Forks 28
Watchers 15
Contributors 7
Repo Size: 40 KB

Top Contributors See all

Sindre Sorhus Thomas Watson Arthur Verschaeve Eric Mandel Sam Verschueren Bogdan Chadkin paarthenon

Something wrong with this page? Make a suggestion

Export .ABOUT file for this library

Last synced: 2017-04-16 09:02:19 UTC

Login to resync this project