# inquirer-filefolder-prompt

> File/folder prompt for Inquirer.js

Latest version **0.0.1** (published 2019-04-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install inquirer-filefolder-prompt
pnpm add inquirer-filefolder-prompt
yarn add inquirer-filefolder-prompt
bun add inquirer-filefolder-prompt
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2019-04-28 |
| First published | 2019-04-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 2 |
| Unpacked size | 6.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Zsombor Franczia |
| Maintainers | frzsombor |
| Keywords | inquirer, prompt, file, folder, directory, open, save, dialog, window, cli |

## Links

- npm: https://www.npmjs.com/package/inquirer-filefolder-prompt
- Repository: https://github.com/frzsombor/inquirer-filefolder-prompt
- Homepage: https://github.com/frzsombor/inquirer-filefolder-prompt#readme
- Issues: https://github.com/frzsombor/inquirer-filefolder-prompt/issues
- npm.io page: https://npm.io/package/inquirer-filefolder-prompt

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^2.0.0
- [file-folder-dialogs](https://npm.io/package/file-folder-dialogs.md) ^0.0.1

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2019-04-28

## README

# inquirer-filefolder-prompt

**BETA VERSION! UNDER DEVELOPEMENT!**

File/folder prompt for [Inquirer.js](https://github.com/SBoudrias/Inquirer.js).  
Based on [file-folder-dialogs](https://github.com/frzsombor/file-folder-dialogs).

## Installation

```
npm install --save inquirer-filefolder-prompt
```

## Usage

This prompt is anonymous, meaning you can register this prompt with the type name you please:

```javascript
inquirer.registerPrompt('filefolder', require('inquirer-filefolder-prompt'));
inquirer.prompt({
  type: 'filefolder',
  ...
})
```

Change `name: 'file'` to whatever you might prefer.

### Options

Coming soon...


#### Example

```javascript
inquirer.registerPrompt('filefolder', require('inquirer-filefolder-prompt'));
inquirer.prompt({
  type: 'filefolder',
  name: 'file',
  message: 'Please select the file.',
  dialog: {
      type: 'OpenFileDialog',
      config: {
          'title': 'Open',
          //...
      },
  },
  validate: function(file) {
    if (file.length === 0) {
      return 'No file selected.';
    }
    return true;
  }
}).then(answers => {
  console.log(JSON.stringify(answers, null, '  '));
});
```

See also the [examples](https://github.com/frzsombor/inquirer-filefolder-prompt/blob/master/examples/) folder.

## License

MIT © [Zsombor Franczia](https://github.com/frzsombor/)

---
_Source: https://npm.io/package/inquirer-filefolder-prompt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._