# listr-update-renderer

> Listr update renderer

Latest version **0.5.0** (published 2018-11-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install listr-update-renderer
pnpm add listr-update-renderer
yarn add listr-update-renderer
bun add listr-update-renderer
```

## 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.5.0 |
| Published | 2018-11-17 |
| First published | 2016-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 8 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 37 |
| Author | Sam Verschueren |
| Maintainers | samverschueren |
| Keywords | listr, update, renderer, ora, logupdate, rendering |

## Links

- npm: https://www.npmjs.com/package/listr-update-renderer
- Repository: https://github.com/SamVerschueren/listr-update-renderer
- Homepage: https://github.com/SamVerschueren/listr-update-renderer#readme
- Issues: https://github.com/SamVerschueren/listr-update-renderer/issues
- npm.io page: https://npm.io/package/listr-update-renderer

## Dependencies (8)

- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [figures](https://npm.io/package/figures.md) ^1.7.0
- [log-update](https://npm.io/package/log-update.md) ^2.3.0
- [strip-ansi](https://npm.io/package/strip-ansi.md) ^3.0.1
- [log-symbols](https://npm.io/package/log-symbols.md) ^1.0.2
- [cli-truncate](https://npm.io/package/cli-truncate.md) ^0.2.1
- [indent-string](https://npm.io/package/indent-string.md) ^3.0.0
- [elegant-spinner](https://npm.io/package/elegant-spinner.md) ^1.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.5.0 (latest) — 2018-11-17
- 0.4.0 — 2017-04-07
- 0.3.0 — 2017-04-07
- 0.2.0 — 2017-01-27
- 0.1.4 — 2016-12-20
- 0.1.3 — 2016-12-19
- 0.1.2 — 2016-09-19
- 0.1.1 — 2016-09-15
- 0.1.0 — 2016-09-15

## README

# listr-update-renderer [![Build Status](https://travis-ci.org/SamVerschueren/listr-update-renderer.svg?branch=master)](https://travis-ci.org/SamVerschueren/listr-update-renderer)

> [Listr](https://github.com/SamVerschueren/listr) update renderer

<img src="screenshot.gif" />


## Install

```
$ npm install --save listr-update-renderer
```


## Usage

```js
const UpdaterRenderer = require('listr-update-renderer');
const Listr = require('listr');

const list = new Listr([
    {
        title: 'foo',
        task: () => Promise.resolve('bar')
    }
], {
    renderer: UpdaterRenderer,
	collapse: false
});

list.run();
```

> Note: This is the default renderer for [Listr](https://github.com/SamVerschueren/listr) and doesn't need to be specified.


## Options

These options should be provided in the [Listr](https://github.com/SamVerschueren/listr) options object.

### showSubtasks

Type: `boolean`<br>
Default: `true`

Set to `false` if you want to disable the rendering of the subtasks. Subtasks will be rendered if an error occurred in one of them.

### collapse

Type: `boolean`<br>
Default: `true`

Set to `false` if you don't want subtasks to be hidden after the main task succeed.

### clearOutput

Type: `boolean`<br>
Default: `false`

Clear the output when all the tasks are executed succesfully.


## Related

- [listr](https://github.com/SamVerschueren/listr) - Terminal task list
- [listr-verbose-renderer](https://github.com/SamVerschueren/listr-verbose-renderer) - Listr verbose renderer
- [listr-silent-renderer](https://github.com/SamVerschueren/listr-silent-renderer) - Suppress Listr rendering output


## License

MIT © [Sam Verschueren](https://github.com/SamVerschueren)

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