https://github.com/imcuttle/inquirer-store
Make inquirer's answers persistence even be aborted halfway
https://github.com/imcuttle/inquirer-store
answers inquirer inquirer-store persistence store
Last synced: 7 months ago
JSON representation
Make inquirer's answers persistence even be aborted halfway
- Host: GitHub
- URL: https://github.com/imcuttle/inquirer-store
- Owner: imcuttle
- License: mit
- Created: 2018-10-10T13:30:05.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-07T14:59:43.000Z (almost 4 years ago)
- Last Synced: 2025-03-22T07:02:39.741Z (7 months ago)
- Topics: answers, inquirer, inquirer-store, persistence, store
- Language: JavaScript
- Homepage:
- Size: 119 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: License
Awesome Lists containing this project
README
# inquirer-store
[](https://travis-ci.org/imcuttle/inquirer-store)
[](https://codecov.io/github/imcuttle/inquirer-store?branch=master)
[](https://www.npmjs.com/package/inquirer-store)
[](https://www.npmjs.com/package/inquirer-store)
[](https://prettier.io/)
[](https://conventionalcommits.org)
Make inquirer's answers persistence even be aborted halfway
## How it works?
1. Get default answers by `store`, if `null`, turn to step 3.
2. Reset `default` field of each config.
3. Detect each answer's acceptance by calling `prompt.ui.process.subscribe`, then calls `store.set / store.write` for saving.
## Installation
```bash
npm install inquirer-store
# or use yarn
yarn add inquirer-store
```
## API
### inquirerStore
[index.js:37-62](https://github.com/imcuttle/inquirer-store/blob/17cd137b085d33554c711a90ddfff29ec7f0f0a4/index.js#L37-L62 'Source code on GitHub')
Make inquirer's answers persistence
#### Parameters
- `prompt` {Function}
- `config` same as inquirer
- `opts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
- `opts.store` {Store} Use which store
- `opts.deniesStoreKey` {string}
When config contains `deniesStoreKey` and equals `true`, the prompt's value will not be saved. (optional, default `'deniesStore'`)
- `opts.mode` {'duplex'|'write'|'read'}
The mode about dealing with `store`
- `duplex`: Read and then write with `store`
- `write`: Just write data to `store`
- `read`: Just read data from `store` (optional, default `'duplex'`)
#### Examples
```javascript
const inquirerStore = require('inquirer-store')
const FileStore = require('inquirer-store/FileStore')
const inquirer = require('inquirer')
inquirerStore(
inquirer.prompt,
[
{ type: 'input', message: 'Hi...', name: 'name' },
{ type: 'input', message: 'Hi...', name: 'deny', deniesStore: true }
],
{
store: new FileStore({ storePath: '/path/to/where.json' })
}
).then(answers => {
// `answers` would be setting in `default` as default value at next time
// but excluding `answers.deny`
})
```
### Store
[Store.js:30-98](https://github.com/imcuttle/inquirer-store/blob/17cd137b085d33554c711a90ddfff29ec7f0f0a4/Store.js#L30-L98 'Source code on GitHub')
Base Class for storing to anywhere, don't use it directly
#### Parameters
- `options` {object}
#### Examples
```javascript
const Store = require('inquirer-store/Store')
// Write customized store class
class MyStore extends Store {
static defaultOptions = {
data: { name: 'imcuttle' }
}
// Note: It must be a sync operation
_read() {
const { data } = this.options
return data
}
// Note: It must be a sync operation
_write(data) {
// Save data for persistence here
}
}
```
#### options
[Store.js:37-37](https://github.com/imcuttle/inquirer-store/blob/17cd137b085d33554c711a90ddfff29ec7f0f0a4/Store.js#L37-L37 'Source code on GitHub')
extends from `this.constructor.defaultOptions` and `options`
Type: [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
#### data
[Store.js:43-43](https://github.com/imcuttle/inquirer-store/blob/17cd137b085d33554c711a90ddfff29ec7f0f0a4/Store.js#L43-L43 'Source code on GitHub')
Existing data in actually
Type: [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
#### get
[Store.js:57-59](https://github.com/imcuttle/inquirer-store/blob/17cd137b085d33554c711a90ddfff29ec7f0f0a4/Store.js#L57-L59 'Source code on GitHub')
Get `this.data[name]`
##### Parameters
- `name` {string}
Returns **any**
#### set
[Store.js:67-69](https://github.com/imcuttle/inquirer-store/blob/17cd137b085d33554c711a90ddfff29ec7f0f0a4/Store.js#L67-L69 'Source code on GitHub')
Set `this.data[name]` to be `value`
##### Parameters
- `name` {string}
- `value` {any}
#### unset
[Store.js:76-78](https://github.com/imcuttle/inquirer-store/blob/17cd137b085d33554c711a90ddfff29ec7f0f0a4/Store.js#L76-L78 'Source code on GitHub')
Delete `this.data[name]`
##### Parameters
- `name` {string}
#### clear
[Store.js:84-86](https://github.com/imcuttle/inquirer-store/blob/17cd137b085d33554c711a90ddfff29ec7f0f0a4/Store.js#L84-L86 'Source code on GitHub')
Clear `this.data`
#### write
[Store.js:95-97](https://github.com/imcuttle/inquirer-store/blob/17cd137b085d33554c711a90ddfff29ec7f0f0a4/Store.js#L95-L97 'Source code on GitHub')
Write `this.data` for persistence
##### Parameters
- `data` (optional, default `{}`)
### FileStore
[FileStore.js:24-52](https://github.com/imcuttle/inquirer-store/blob/17cd137b085d33554c711a90ddfff29ec7f0f0a4/FileStore.js#L24-L52 'Source code on GitHub')
**Extends Store**
Store's implementation in file system
#### Parameters
- `options` {object}
- `options.key` {string|null}
When `null`, use store from `storePath` as data, otherwise use `store[key]` as data. (optional, default `null`)
- `options.storePath` {string|null] - File path for storing data (optional, default `null`)
- `options.parse` {string: string => object} Parse the text from file `storePath` (optional, default `JSON.parse`)
- `options.stringify` {data: object => string} Stringify data for saving in `storePath` (optional, default `JSON.stringify`)
- `options.fs` It's useful for mocking data by overriding `existsSync / readFileSync / writeFileSync` methods (optional, default `require('fs')`)
### fillConfigDefault
[index.js:79-89](https://github.com/imcuttle/inquirer-store/blob/17cd137b085d33554c711a90ddfff29ec7f0f0a4/index.js#L79-L89 'Source code on GitHub')
Fill config's `default` field
#### Parameters
- `config` {Array | object}
- `store` {Store}
#### Examples
```javascript
const { fillConfigDefault } = require('inquirer-store')
fillConfigDefault(
[{ type: 'input', name: 'name', default: 'foo' }],
new FileStore({ storePath: '/path/to/where.json' })
)
// [{ type: 'input', name: 'name', default: 'the value that you has inputted in last time' }]
```
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>**
## Contributing
- Fork it!
- Create your new branch:
`git checkout -b feature-new` or `git checkout -b fix-which-bug`
- Start your magic work now
- Make sure npm test passes
- Commit your changes:
`git commit -am 'feat: some description (close #123)'` or `git commit -am 'fix: some description (fix #123)'`
- Push to the branch: `git push`
- Submit a pull request :)
## Authors
This library is written and maintained by imcuttle, moyuyc95@gmail.com.
## License
MIT - [imcuttle](https://github.com/imcuttle) 🐟