explorer-opener/README.md

📁 Open file explorer with Node.js

# explorer-opener

📁 Open file explorer with Node.js

![npm-version](https://img.shields.io/npm/v/explorer-opener)
![build-status-badge](https://img.shields.io/github/actions/workflow/status/goveo/explorer-opener/release.yml?branch=master)
![install-size-badge](https://badgen.net/packagephobia/install/explorer-opener)
[![codecov](https://codecov.io/gh/goveo/explorer-opener/branch/master/graph/badge.svg)](https://codecov.io/gh/goveo/explorer-opener)

## Basic Usage

```ts
import { openExplorer } from 'explorer-opener';

openExplorer('C:\\Windows\\System32')
  .then(() => {
    // handle successful open
  })
  .catch((error) => {
    // handle error
  });
```

⚠️ Rejected promise will be returned if provided path does not exist:

```ts
openExplorer('/test/folder').catch((error) => {
  // error: `File or directory "/test/folder" does not exist`
});
```

## Default path values

Default values will be used if `path` is not specified:

- Windows: `"="`
- Linux: `"/"`
- MacOS: `"/"`

## Supported platforms

- Windows (`"win32"`)
- Linux (`"linux"`)
- MacOS (`"darwin"`)

⚠️ Rejected promise will be returned if it's called from not supported platform:

```ts
// os: android
openExplorer().catch((error) => {
  // error: `Can not detect "android" platform`
});
```