# qm-util-edit-in-console

> Edit data in console using terminal editor.

Latest version **0.1.0** (published 2018-01-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install qm-util-edit-in-console
pnpm add qm-util-edit-in-console
yarn add qm-util-edit-in-console
bun add qm-util-edit-in-console
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-01-25 |
| First published | 2018-01-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | qaraluch |
| Maintainers | qaraluch |

## Links

- npm: https://www.npmjs.com/package/qm-util-edit-in-console
- Repository: https://github.com/qaraluch/qm-util-edit-in-console
- Issues: https://github.com/qaraluch/qm-util-edit-in-console/issues
- npm.io page: https://npm.io/package/qm-util-edit-in-console

## Dependencies (5)

- [del](https://npm.io/package/del.md) 3.0.0
- [p-if](https://npm.io/package/p-if.md) 1.1.0
- [qm-fs-touch](https://npm.io/package/qm-fs-touch.md) 0.1.2
- [babel-runtime](https://npm.io/package/babel-runtime.md) 6.26.0
- [load-json-file](https://npm.io/package/load-json-file.md) 4.0.0

## Recent versions

- 0.1.0 (latest) — 2018-01-25

## README

![logo-qm](./pic/logo-qm.jpg)

# qm-util-edit-in-console [![npm version](https://badge.fury.io/js/qm-util-edit-in-console.svg)](https://badge.fury.io/js/qm-util-edit-in-console) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

> Edit .json data in console using terminal editor (promisfied).

## Installation

```sh
$ npm i -S qm-util-edit-in-console
```

## Usage

```js
import editInConsole from "qm-util-edit-in-console";

  // default options
  const options = {
    fileName: ".tempToEditInVim.json",
    editor: "vim",
    dirPath: process.cwd(),
    removeTempFile: true
  };

async function edit() {
  try {
    const objToEdit = { editMe: "terefere" };
    const newObj = await editInConsole(objToEdit, options);
    console.log("newObj ", newObj);
  } catch (error) {
    console.log("Error: ", error);
  }
}();
```

## Credits

Based on [substack/node-editor](https://github.com/substack/node-editor).

## License

MIT © [qaraluch](https://github.com/qaraluch)

---
_Source: https://npm.io/package/qm-util-edit-in-console · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._