Update checked-in dependencies
This commit is contained in:
github-actions[bot]
parent
4fad06f438
commit
40a500c743
4168 changed files with 298222 additions and 374905 deletions
85
node_modules/open/readme.md
generated
vendored
85
node_modules/open/readme.md
generated
vendored
|
|
@ -14,19 +14,21 @@ This package does not make any security guarantees. If you pass in untrusted inp
|
|||
- Supports app arguments.
|
||||
- Safer as it uses `spawn` instead of `exec`.
|
||||
- Fixes most of the original `node-open` issues.
|
||||
- Includes the latest [`xdg-open` script](https://cgit.freedesktop.org/xdg/xdg-utils/commit/?id=c55122295c2a480fa721a9614f0e2d42b2949c18) for Linux.
|
||||
- Includes the latest [`xdg-open` script](https://gitlab.freedesktop.org/xdg/xdg-utils/-/blob/master/scripts/xdg-open.in) for Linux.
|
||||
- Supports WSL paths to Windows apps.
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
npm install open
|
||||
```
|
||||
$ npm install open
|
||||
```
|
||||
|
||||
**Warning:** This package is native [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) and no longer provides a CommonJS export. If your project uses CommonJS, you will have to [convert to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) or use the [dynamic `import()`](https://v8.dev/features/dynamic-import) function. Please don't open issues for questions regarding CommonJS / ESM.
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const open = require('open');
|
||||
import open, {openApp, apps} from 'open';
|
||||
|
||||
// Opens the image in the default image viewer and waits for the opened app to quit.
|
||||
await open('unicorn.png', {wait: true});
|
||||
|
|
@ -41,11 +43,14 @@ await open('https://sindresorhus.com', {app: {name: 'firefox'}});
|
|||
// Specify app arguments.
|
||||
await open('https://sindresorhus.com', {app: {name: 'google chrome', arguments: ['--incognito']}});
|
||||
|
||||
// Open an app
|
||||
await open.openApp('xcode');
|
||||
// Opens the URL in the default browser in incognito mode.
|
||||
await open('https://sindresorhus.com', {app: {name: apps.browserPrivate}});
|
||||
|
||||
// Open an app with arguments
|
||||
await open.openApp(open.apps.chrome, {arguments: ['--incognito']});
|
||||
// Open an app.
|
||||
await openApp('xcode');
|
||||
|
||||
// Open an app with arguments.
|
||||
await openApp(apps.chrome, {arguments: ['--incognito']});
|
||||
```
|
||||
|
||||
## API
|
||||
|
|
@ -101,7 +106,7 @@ Type: `{name: string | string[], arguments?: string[]} | Array<{name: string | s
|
|||
|
||||
Specify the `name` of the app to open the `target` with, and optionally, app `arguments`. `app` can be an array of apps to try to open and `name` can be an array of app names to try. If each app fails, the last error will be thrown.
|
||||
|
||||
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. If possible, use [`open.apps`](#openapps) which auto-detects the correct binary to use.
|
||||
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. If possible, use [`apps`](#apps) which auto-detects the correct binary to use.
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -116,27 +121,7 @@ Allow the opened app to exit with nonzero exit code when the `wait` option is `t
|
|||
|
||||
We do not recommend setting this option. The convention for success is exit code zero.
|
||||
|
||||
### open.apps
|
||||
|
||||
An object containing auto-detected binary names for common apps. Useful to work around [cross-platform differences](#app).
|
||||
|
||||
```js
|
||||
const open = require('open');
|
||||
|
||||
await open('https://google.com', {
|
||||
app: {
|
||||
name: open.apps.chrome
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
#### Supported apps
|
||||
|
||||
- [`chrome`](https://www.google.com/chrome) - Web browser
|
||||
- [`firefox`](https://www.mozilla.org/firefox) - Web browser
|
||||
- [`edge`](https://www.microsoft.com/edge) - Web browser
|
||||
|
||||
### open.openApp(name, options?)
|
||||
### openApp(name, options?)
|
||||
|
||||
Open an app.
|
||||
|
||||
|
|
@ -146,7 +131,7 @@ Returns a promise for the [spawned child process](https://nodejs.org/api/child_p
|
|||
|
||||
Type: `string`
|
||||
|
||||
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. If possible, use [`open.apps`](#openapps) which auto-detects the correct binary to use.
|
||||
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. If possible, use [`apps`](#apps) which auto-detects the correct binary to use.
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -165,19 +150,33 @@ Arguments passed to the app.
|
|||
|
||||
These arguments are app dependent. Check the app's documentation for what arguments it accepts.
|
||||
|
||||
### apps
|
||||
|
||||
An object containing auto-detected binary names for common apps. Useful to work around [cross-platform differences](#app).
|
||||
|
||||
```js
|
||||
import open, {apps} from 'open';
|
||||
|
||||
await open('https://google.com', {
|
||||
app: {
|
||||
name: apps.chrome
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
`browser` and `browserPrivate` can also be used to access the user's default browser through [`default-browser`](https://github.com/sindresorhus/default-browser).
|
||||
|
||||
#### Supported apps
|
||||
|
||||
- [`chrome`](https://www.google.com/chrome) - Web browser
|
||||
- [`firefox`](https://www.mozilla.org/firefox) - Web browser
|
||||
- [`edge`](https://www.microsoft.com/edge) - Web browser
|
||||
- `browser` - Default web browser
|
||||
- `browserPrivate` - Default web browser in incognito mode
|
||||
|
||||
`browser` and `browserPrivate` only supports `chrome`, `firefox`, and `edge`.
|
||||
|
||||
## Related
|
||||
|
||||
- [open-cli](https://github.com/sindresorhus/open-cli) - CLI for this module
|
||||
- [open-editor](https://github.com/sindresorhus/open-editor) - Open files in your editor at a specific line and column
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
<b>
|
||||
<a href="https://tidelift.com/subscription/pkg/npm-opn?utm_source=npm-opn&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
||||
</b>
|
||||
<br>
|
||||
<sub>
|
||||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
||||
</sub>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue