Skip to content
Listr update renderer
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib support non-string output - fixes #3 Dec 19, 2016
.editorconfig Meta tweaks Nov 17, 2018
.gitattributes init Sep 15, 2016
.gitignore init Sep 15, 2016
.npmrc
.travis.yml
example.js Meta tweaks Nov 17, 2018
index.js Meta tweaks Nov 17, 2018
license init Sep 15, 2016
package.json Bump `figures` (#21) Dec 6, 2018
readme.md Rename `clear` to `clearOutput` Apr 7, 2017
screenshot.gif

readme.md

listr-update-renderer Build Status

Listr update renderer

Install

$ npm install --save listr-update-renderer

Usage

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 and doesn't need to be specified.

Options

These options should be provided in the Listr options object.

showSubtasks

Type: boolean
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
Default: true

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

clearOutput

Type: boolean
Default: false

Clear the output when all the tasks are executed succesfully.

Related

License

MIT © Sam Verschueren

You can’t perform that action at this time.