71 lines
2.3 KiB
TypeScript
71 lines
2.3 KiB
TypeScript
|
/// <reference types="node"/>
|
||
|
|
import {ChildProcess} from 'child_process';
|
||
|
|
|
||
|
|
declare namespace open {
|
||
|
|
interface Options {
|
||
|
|
/**
|
||
|
|
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.
|
||
|
|
|
||
|
|
@default false
|
||
|
|
*/
|
||
|
|
readonly wait?: boolean;
|
||
|
|
|
||
|
|
/**
|
||
|
|
__macOS only__
|
||
|
|
|
||
|
|
Do not bring the app to the foreground.
|
||
|
|
|
||
|
|
@default false
|
||
|
|
*/
|
||
|
|
readonly background?: boolean;
|
||
|
|
|
||
|
|
/**
|
||
|
|
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.
|
||
|
|
*/
|
||
|
|
readonly app?: string | readonly string[];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
Open stuff like URLs, files, executables. Cross-platform.
|
||
|
|
|
||
|
|
Uses the command `open` on OS X, `start` on Windows and `xdg-open` on other platforms.
|
||
|
|
|
||
|
|
@param target - 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 open in your default browser.
|
||
|
|
@returns The [spawned child process](https://nodejs.org/api/child_process.html#child_process_class_childprocess). 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.
|
||
|
|
|
||
|
|
@example
|
||
|
|
```
|
||
|
|
import 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']});
|
||
|
|
})();
|
||
|
|
```
|
||
|
|
*/
|
||
|
|
declare function open(
|
||
|
|
target: string,
|
||
|
|
options?: open.Options
|
||
|
|
): Promise<ChildProcess>;
|
||
|
|
|
||
|
|
export = open;
|